operations

Add a new operation to the database.

POST

/operation

curl --request POST \
  --url https://api-sandbox.timeking.nl/api/external/v1/operation \
  --header 'X-API-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "categories": [
    {
      "code": "<string>",
      "color": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>"
    }
  ],
  "code": "<string>",
  "color": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "external_ids": {},
  "extra_data": {},
  "id": 123,
  "is_internal_operation": 123,
  "name": "<string>",
  "opcode": "<string>",
  "price_type": "<string>",
  "questions": [
    {
      "answer_type": "<string>",
      "answer_values": [
        {
          "value": "<string>"
        }
      ],
      "id": 123,
      "question": "<string>",
      "required": true,
      "sort_order": 123
    }
  ],
  "sort_order": 123,
  "unit_id": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}
'

{
  "data": {
    "operation": {
      "categories": [
        {
          "code": "<string>",
          "color": "<string>",
          "description": "<string>",
          "id": 123,
          "name": "<string>"
        }
      ],
      "code": "<string>",
      "color": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "external_ids": {},
      "extra_data": {},
      "id": 123,
      "is_internal_operation": 123,
      "name": "<string>",
      "opcode": "<string>",
      "price_type": "<string>",
      "questions": [
        {
          "answer_type": "<string>",
          "answer_values": [
            {
              "value": "<string>"
            }
          ],
          "id": 123,
          "question": "<string>",
          "required": true,
          "sort_order": 123
        }
      ],
      "sort_order": 123,
      "unit_id": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "result": "<string>"
  },
  "status": "<string>"
}

Autorisaties

X-API-Keystringheaderverplicht

Body

Operation object.

categoriesobject[]

The operation categories this operation belongs to.

child attributes tonen

codestring

The unique code of this operation.

colorstring

The hex color of this operation, e.g. '#d35400'.

created_atstring

The date and time this operation was created.

deleted_atstring

The date and time this operation was archived, or null when it is active.

external_idsobject

The IDs of this operation in connected third party applications, keyed by connection.

extra_dataobject

The values of the custom fields, keyed by custom field code.

idintegerverplicht

The ID of this operation.

is_internal_operationinteger

Whether this is an internal business operation instead of a regular operation. Returned as 1 (yes) or 0 (no).

namestring

The name of this operation.

opcodestring

The operation code of this operation.

price_typestring

The price type of this operation, either 'time' or 'article'.

questionsobject[]

The questions asked when this operation is registered.

child attributes tonen

sort_orderinteger

The sort order of this operation.

unit_idinteger

The ID of the unit of this operation.

updated_atstring

The date and time this operation was last updated.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team