Create New Resource

POST

/resource

Create a new Resource and store it

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:

machinecellemployee

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

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

null

integer | null

required

>= 0<= 24

Default:

null

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}$

boards

array [object {3}]

required

string <uuid>

required

Unique identifier

stages

array [object {3}]

required

active

boolean

optional

Example

{
    "name": "Della Grady",
    "type": "employee",
    "description": "Substantia vigilo placeat conturbo vesper. Videlicet delibero vos valde totidem arcesso carbo. Aeneus traho deleniti. Cimentarius crux tandem exercitationem cupiditate. Ars ustilo dicta quis aperiam. Fugiat comitatus absque casus celer bibo.",
    "start_date": "2024-08-29",
    "end_date": "2025-09-30",
    "avatar": "https://avatars.githubusercontent.com/u/54458177",
    "workdays": {
        "1": null,
        "2": null,
        "3": 10,
        "4": 8,
        "5": null,
        "6": null,
        "7": null
    },
    "integration_schedule": false,
    "color_hex": "#3d6",
    "boards": [
        {
            "id": "15830041-a548-457f-ae6f-3524dcd6c200",
            "stages": [
                {
                    "id": "888064b3-69da-4949-befc-3347c5ea05b6",
                    "percentage": 75,
                    "active": true
                },
                {
                    "id": "7beb9e59-3ab6-4374-af6e-adc81e47c3fb",
                    "percentage": 813,
                    "active": false
                }
            ],
            "active": true
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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 '{
    "name": "Della Grady",
    "type": "employee",
    "description": "Substantia vigilo placeat conturbo vesper. Videlicet delibero vos valde totidem arcesso carbo. Aeneus traho deleniti. Cimentarius crux tandem exercitationem cupiditate. Ars ustilo dicta quis aperiam. Fugiat comitatus absque casus celer bibo.",
    "start_date": "2024-08-29",
    "end_date": "2025-09-30",
    "avatar": "https://avatars.githubusercontent.com/u/54458177",
    "workdays": {
        "1": null,
        "2": null,
        "3": 10,
        "4": 8,
        "5": null,
        "6": null,
        "7": null
    },
    "integration_schedule": false,
    "color_hex": "#3d6",
    "boards": [
        {
            "id": "15830041-a548-457f-ae6f-3524dcd6c200",
            "stages": [
                {
                    "id": "888064b3-69da-4949-befc-3347c5ea05b6",
                    "percentage": 75,
                    "active": true
                },
                {
                    "id": "7beb9e59-3ab6-4374-af6e-adc81e47c3fb",
                    "percentage": 813,
                    "active": false
                }
            ],
            "active": true
        }
    ]
}'

Responses

🟢201Created

application/json

Body

string <uuid>

read-onlyoptional

Unique identifier

name

string

optional

type

enum<string>

optional

Allowed values:

machinecellemployee

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

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

integer | null

required

>= 0<= 24

Default:

null

integer | null

required

>= 0<= 24

Default:

null

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> | null

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": 8,
        "2": 8,
        "3": 8,
        "4": 8,
        "5": 8,
        "6": null,
        "7": null
    },
    "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

Modified at 2025-06-30 07:38:44

Retrieve Resource List

Retrieve Single Resource