Patch Project
  • 17 Jul 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Patch Project

  • Dark
    Light
  • PDF

Article summary

Patch Project

/v1/projects

Maintain Projects

Safran Project ILAP Gateway

This API endpoint is only available in the Safran Project ILAP Gateway product.



### Example for calling:
http://server/v1/projects
http://server/v1/projects?owner=safransa


Request Body = {...} see request fields below.

Allowed Methods:

[PATCH]
API Controller: project

Description:

Update single project with the details provided, all other details remains as is. The project must be present which are to be patched. Should project id be missing the API will use the network id, should it also be missing the API will attempt to identify the project using the project name. API will only allow to patch one project per call.

Parameters

NameTypeDescriptionNotes
ownerstringOwner of the projectRelates to "SafranWebApiOwnerVerificationDuringApiCalls" in Application Settings


Request Fields

NameTypeDescriptionNotes
create_projectcreate_project[]Collection of details for one project ro be patchedHead element not specified - see example
Same structure as POST Create, Update or Delete project


  • create_project are reused in this PATCH API as found in the POST API, however the following elements are not used in this API:
    • ProjectAction
    • UpdateIfExists
    • LowestDurationUnits
  • RowID is mandatory, as are either project_id, network_id or project_name.
  • In current version the API only supports patching ana_tnow. When updating the ana_tnow the following fields will also be set by the API:
    • ana_date = null
    • na_date = current database date

Response Fields

NameTypeDescriptionNotes
Project_NamestringName of the project
Network_idintegerIdentification of the project
RowIdintegerLines up with the RowID in create_project in the Request fields
ResultstringIndicate the success of failure of the actionS = Success, F = Failure


Show Call Sample

Call Sample

[
  {
    "RowID":1,
    "network_id":11,
    "project_name":"Engine Maintenance",
    "ana_tnow":"2020-11-25"
  }
]

Show Response Sample

json result

[
    {
        "Network_Id": 11,
        "Project_Name": "Engine Maintenance",
        "RowId": 1,
        "Result": "S"
    }
]


Was this article helpful?

ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence