.png){kind=logo}
Cutoff
- 17 Jul 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Cutoff
- Updated on 17 Jul 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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 :
| Name | Type | Description | Notes |
|---|---|---|---|
| id | integer | Id of the project | Optional Returns cutoff details for provided project id |
| network_id | integer | id of the related network | Optional Returns cutoff details for provided network id |
| owner | string | Owner of the project | Relates to "SafranWebApiOwnerVerificationDuringApiCalls" in Application Settings |
| item_guid | guid | guid of the network | Optional 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:
| Name | Type | Description | Notes |
|---|---|---|---|
| week_end | datetime | last cut off date for the project | |
| project_id | integer | Unique ID of the project | |
| net_id | integer | Unique network Id | |
| LastUpdatedUTC | datetime | Date and time when details was updated | Time 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?