Create New Resource

Request

Query Params

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:

Body Params application/json

name

string

optional

type

enum<string>

optional

Allowed values:

resourcemachinecell

Default:

resource

description

string

optional

start_date

string <date>

optional

end_date

string <date> | null

optional

avatar

string <uri> | null

optional

workdays

object (ResourceWorkdays)

optional

Days of the week that are considered workdays

1

integer | null

required

2

integer | null

required

3

integer | null

required

4

integer | null

required

5

integer | null

required

6

integer | null

required

7

integer | null

required

integration_schedule

boolean

optional

If false, vPlan manages the schedules via workdays. When true, integration manages the schedules

color_hex

string

optional

Color hex is used to signify the Resource, only used if the avatar is null

Match pattern:

^#([0-9a-f]{3}){1,2}$

Example

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.vplan.com/v1/resource?show=&hide=' \
--header 'x-api-key;' \
--header 'x-api-env;' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢201Created

application/json

Body

id

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

type

enum<string>

optional

Allowed values:

resourcemachinecell

Default:

resource

description

string

optional

start_date

string <date>

optional

end_date

string <date> | null

optional

avatar

string <uri> | null

optional

workdays

object (ResourceWorkdays)

optional

Days of the week that are considered workdays

1

integer | null

required

2

integer | null

required

3

integer | null

required

4

integer | null

required

5

integer | null

required

6

integer | null

required

7

integer | null

required

integration_schedule

boolean

optional

If false, vPlan manages the schedules via workdays. When true, integration manages the schedules

color_hex

string

optional

Color hex is used to signify the Resource, only used if the avatar is null

Match pattern:

^#([0-9a-f]{3}){1,2}$

external_ref

string | null

read-onlyoptional

Third-party reference of the object, for informational purposes only

Example:

fb1033a2ed70

created_at

string <date-time>

read-onlyoptional

Date and time of creation

Example:

2024-04-11T10:22:15Z

updated_at

string <date-time>

read-onlyoptional

Date and time of last update

Example:

2024-04-11T10:22:15Z

archived_at

string <date-time>

read-onlyoptional

Date and time that the object is archived

Example:

2021-07-06T11:24:35Z

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "resource",
  "description": "string",
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "avatar": "http://example.com",
  "workdays": {
    "1": 0,
    "2": 0,
    "3": 0,
    "4": 0,
    "5": 0,
    "6": 0,
    "7": 0
  },
  "integration_schedule": true,
  "color_hex": "string",
  "external_ref": "fb1033a2ed70",
  "created_at": "2024-04-11T10:22:15Z",
  "updated_at": "2024-04-11T10:22:15Z",
  "archived_at": "2021-07-06T11:24:35Z"
}

🟠422Unprocessable Content

🟠401Not Logged In