Get contracts states

GET 
/api/v2/Contracts/States

Get contracts states

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.

Responses

200

Success

application/json

Schema

Schema

ContinuationToken stringnullable
Items object[]nullable
Array [
Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
TimestampChanged date-timenullable
Name stringnullable
Possible values: <= 100 characters
DisplayName stringnullable
Possible values: <= 100 characters
Visibility ContractStateVisibility (string)
Possible values: [Contracts, Subcontracts, All]
Color stringnullable
Possible values: <= 7 characters
SortOrder integer
ExternalKey stringnullable
]

Example (from schema)

{
  "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",
      "DisplayName": "string",
      "Visibility": "Contracts",
      "Color": "string",
      "SortOrder": 0,
      "ExternalKey": "string"
    }
  ]
}

400

Error

application/json

Schema

Schema

Error objectrequired
Code stringnullable
Message stringnullable

Example (from schema)

{
  "Error": {
    "Code": "string",
    "Message": "string"
  }
}

Loading...