Retrieve Deviation List

Request

Path Params

resource_id

string <uuid>

required

Query Params

limit

integer

optional

Number of maximum records given. More info pagination

Default:

100

offset

integer

optional

Number of records to be skipped. More info pagination

Default:

0

filter

string

optional

Filter the dataset. More info filtering

sort

string

optional

Sorting the dataset. More info sorting

show

string

optional

Show only specific properties from the response. More info show & hide

hide

string

optional

Hide properties from the response. More info show & hide

Header Params

x-api-key

string

required

Default:

x-api-env

string

required

Default:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.vplan.com/v1/resource//schedule_deviation?limit=100&offset=0&filter=&sort=&show=&hide=' \
--header 'x-api-key;' \
--header 'x-api-env;'

Responses

🟢200Ok

application/json

Body

count

integer <uint64>

optional

Total amount of items

>= 0

Default:

1

limit

integer <uint64>

optional

Max amount of items fetched

>= 0<= 1000

Default:

100

offset

integer <uint64>

optional

Offset so items may be paginated

>= 0

Default:

0

data

array[object (Schedule Deviation) {12}]

optional

Items

id

string

optional

resource_id

string

optional

description

string

optional

type

enum<string>

optional

Allowed values:

othereventtravelholidayleavepartymaintenancemalfunction

start_date

string <date>

optional

end_date

string <date>

optional

time

integer | null

optional

external_ref

null

optional

icon

string

optional

color

string

optional

created_at

string

optional

updated_at

string

optional

Example

{
    "count": 1,
    "limit": 100,
    "offset": 0,
    "data": [
        {
            "id": "string",
            "resource_id": "string",
            "description": "string",
            "type": "other",
            "start_date": "2019-08-24",
            "end_date": "2019-08-24",
            "time": 0,
            "external_ref": null,
            "icon": "string",
            "color": "string",
            "created_at": "string",
            "updated_at": "string"
        }
    ]
}

🟠404Not Found

🟠401Not Logged In