Get Contract State

Get Contract State

Path Parameters

• key string required

  Guid or ExternalKey

Responses

• 200
• 404

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• Guid guid
• Revision int64
• PersonCreated guid nullable
• PersonChanged guid nullable
• TimestampCreated date-time nullable
• TimestampChanged date-time nullable
• Name string nullable

  Possible values: <= 100 characters

• DisplayName string nullable

  Possible values: <= 100 characters

• Visibility ContractStateVisibility

  Possible values: [Contracts, Subcontracts, All]

• Color string nullable

  Possible values: <= 7 characters

• SortOrder integer
• ExternalKey string nullable

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2023-11-06T13:22:00Z",
  "TimestampChanged": "2023-11-06T13:22:00Z",
  "Name": "string",
  "DisplayName": "string",
  "Visibility": "Contracts",
  "Color": "string",
  "SortOrder": 0,
  "ExternalKey": "string"
}

Not found

application/json

• Schema
• Example (from schema)

---

Schema

• Guid guid
• Revision int64
• PersonCreated guid nullable
• PersonChanged guid nullable
• TimestampCreated date-time nullable
• TimestampChanged date-time nullable
• Name string nullable required
• Code string nullable
• Type object

  oneOf

  • ActivityType

  ---

  string

  Possible values: [Work, Absence, Break]

Default boolean

TimeEntry object

oneOf

• ActivityTypeTimeEntry

---

string

Possible values: [Optional, TotalTime, FromTo]

Inactive boolean

Movement boolean

Icon string nullable

ExternalKey string nullable

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2023-11-06T13:22:00Z",
  "TimestampChanged": "2023-11-06T13:22:00Z",
  "Name": "string",
  "Code": "string",
  "Type": "Work",
  "Default": true,
  "TimeEntry": "Optional",
  "Inactive": true,
  "Movement": true,
  "Icon": "string",
  "ExternalKey": "string"
}