Get subcontracts
GET/api/v2/Contracts/Subcontracts
Get subcontracts
Request
Query Parameters
ContinuationToken string
Token is needed, unless all records have been returned in previous request. Do not forget to pass also all other parameters.
contractKey string
Contract Guid or ExternalKey
Responses
- 200
- 400
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
ContinuationToken stringnullable
Items object[]nullable
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
Name stringnullablerequired
Code stringnullable
Contract guid
Description stringnullable
EndDate datenullable
Billable BillableFlags (string)
Possible values: [None
, Billable
, ChangeAllowed
, BillableChangeAllowed
]
Note stringnullable
CostsPlanned int64nullable
HoursPlanned int64nullable
CustomFields objectnullable
ExternalKey stringnullable
States string[]nullable
ResponsiblePerson guidnullable
CompletionDate date-timenullable
{
"ContinuationToken": "string",
"Items": [
{
"Guid": "string",
"Revision": 0,
"PersonCreated": "string",
"PersonChanged": "string",
"TimestampCreated": "2024-03-29T06:55:00Z",
"TimestampChanged": "2024-03-29T06:55:00Z",
"Name": "string",
"Code": "string",
"Contract": "string",
"Description": "string",
"EndDate": "2024-03-29",
"Billable": "None",
"Note": "string",
"CostsPlanned": 0,
"HoursPlanned": 0,
"CustomFields": {
"MyCustomField": "value",
"MyNestedObject": {
"MyNestedProperty": "value"
}
},
"ExternalKey": "string",
"States": [
"string"
],
"ResponsiblePerson": "string",
"CompletionDate": "2024-03-29T06:57:03.538Z"
}
]
}
Error
- application/json
- Schema
- Example (from schema)
Schema
Error objectrequired
Code stringnullable
Message stringnullable
{
"Error": {
"Code": "string",
"Message": "string"
}
}
Loading...