Get Plan Record

GET 
/api/v2/Plan/:key

Get Plan Record

Request

Path Parameters

key stringrequired

Guid or ExternalKey

Responses

200

Success

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example: 2024-10-07T12:48:00Z
CustomFields objectnullable
Person guidrequired
Date datenullable
From date-timenullable
To date-timenullable
Hours durationnullable
Activity guidrequired
Description stringnullable
Contract guidnullable
Subcontract guidnullable
ExternalKey stringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-10-07T12:48:00Z",
  "TimestampChanged": "2024-10-07T12:48:00Z",
  "CustomFields": {},
  "Person": "string",
  "Date": "2024-07-29",
  "From": "2024-07-29T15:51:28.071Z",
  "To": "2024-07-29T15:51:28.071Z",
  "Hours": "string",
  "Activity": "string",
  "Description": "string",
  "Contract": "string",
  "Subcontract": "string",
  "ExternalKey": "string"
}

404

Not found

application/json

Schema

Schema

Guid guid
Revision int64
PersonCreated guidnullable
PersonChanged guidnullable
TimestampCreated date-timenullable
Example: 2024-10-07T12:48:00Z
TimestampChanged date-timenullable
Example: 2024-10-07T12:48:00Z
Name stringnullablerequired
Code stringnullable

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 stringnullable
ExternalKey stringnullable

Example (from schema)

{
  "Guid": "string",
  "Revision": 0,
  "PersonCreated": "string",
  "PersonChanged": "string",
  "TimestampCreated": "2024-10-07T12:48:00Z",
  "TimestampChanged": "2024-10-07T12:48:00Z",
  "Name": "string",
  "Code": "string",
  "Type": "Work",
  "Default": true,
  "TimeEntry": "Optional",
  "Inactive": true,
  "Movement": true,
  "Icon": "string",
  "ExternalKey": "string"
}

Loading...