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

Cutoff

  • Dark
    Light
  • PDF

Article summary

Cutoff

/v1/cutoff/{id}

Retrieves one or more projects cutoff details.

Regarding relation of network_id and project_id see project_previews for more details.

Example for calling:

http://server/v1/cutoff?id=1 - Retrieves cutoff details for project having project_id = 1

http://server/v1/cutoff?network_id=2 - Retrieves cutoff details for project having net_id = 2

http://server/v1/cutoff?item_guid=87de7975-097a-45b9-aaf8-51793e74cbdf - Retrieves cutoff details for network having guid = 87de7975-097a-45b9-aaf8-51793e74cbdf

http://server/v1/cutoff?owner=SAFRAN - Retrieves cutoff details for project owned by user SAFRAN

http://server/v1/cutoff?network_id=2&owner=SAFRAN - Retrieves cutoff details for project having net_id = 2 and owned by user SAFRAN

http://server/v1/cutoff - Is not permitted.


Allowed Methods:

[GET]
API Controller: project

Description:

Retrieves the cutoff details of a project for specified id, or all user owned projects when owner is specified.

Request Fields :

NameTypeDescriptionNotes
idintegerId of the projectOptional Returns cutoff details for provided project id
network_idintegerid of the related networkOptional Returns cutoff details for provided network id
ownerstringOwner of the projectRelates to "SafranWebApiOwnerVerificationDuringApiCalls" in Application Settings
item_guidguidguid of the networkOptional Returns cutoff details for provided guid
  • When "SafranWebAPIOwnerVerificationDuringApiCalls" is in use, one of id or network_id is mandatory.
  • If ID, network_id and/or guid is passed to the API, all given values will be used.


Response Fields:

NameTypeDescriptionNotes
week_enddatetimelast cut off date for the project
project_idintegerUnique ID of the project
net_idintegerUnique network Id
LastUpdatedUTCdatetimeDate and time when details was updatedTime is in Coordinated Universal Time


Sample JSON Response

json result

[
    {
        "week_end": "2021-05-16T00:00:00",
        "project_id": 16,
        "net_id": 14,
        "LastUpdatedUTC": "2021-05-20T07:20:07.387"
    },
    {
        "week_end": "2021-05-16T00:00:00",
        "project_id": 24,
        "net_id": 22,
        "LastUpdatedUTC": "2021-05-20T12:35:11.487"
    }
]


Was this article helpful?

What's Next