The Designation object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

designation_name string required
description string
The Designation object 
{
  "id": "designation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "designation_name": "designation_name_example",
  "description": "description_example"
}
GET /api/setup/designation/{id}

Retrieve a designation

Retrieves the details of an existing designation. Supply the unique designation ID that was returned from a previous request.

Path parameters

id string required

The identifier of the designation to retrieve.

Returns

Returns the designation object if a valid identifier was provided.

GET /api/setup/designation/{id} 
curl https://api.overplane.dev/api/setup/designation/designation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "designation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "designation_name": "designation_name_example",
  "description": "description_example"
}
GET /api/setup/designation

List all designations

Returns a list of designations. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of designation objects.

GET /api/setup/designation 
curl https://api.overplane.dev/api/setup/designation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "designation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "designation_name": "designation_name_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/designation

Create a designation

Creates a new designation object.

Body parameters

designation_name string required
description string

Returns

Returns the newly created designation object if the call succeeded.

POST /api/setup/designation 
curl https://api.overplane.dev/api/setup/designation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"designation_name":"designation_name_example"}'
Response 
{
  "id": "designation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "designation_name": "designation_name_example",
  "description": "description_example"
}
PATCH /api/setup/designation/{id}

Update a designation

Updates the specified designation by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the designation to update.

Body parameters

designation_name string
description string

Returns

Returns the updated designation object.

PATCH /api/setup/designation/{id} 
curl https://api.overplane.dev/api/setup/designation/designation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"designation_name":"designation_name_example","description":"description_example"}'
Response 
{
  "id": "designation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "designation_name": "designation_name_example",
  "description": "description_example"
}
DELETE /api/setup/designation/{id}

Delete a designation

Permanently deletes a designation. This cannot be undone.

Path parameters

id string required

The identifier of the designation to delete.

Returns

Returns a confirmation that the designation has been deleted.

DELETE /api/setup/designation/{id} 
curl https://api.overplane.dev/api/setup/designation/designation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "designation_abc123",
  "deleted": true
}