Skip to main content
PUT
/
v3
/
operation-types
/
{operation_type_id}
Update an operation type
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/operation-types/{operation_type_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "colour_palette": "purple",
      "colour_shade": "300",
      "description": "<string>"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "template": {}
    }
  }
}
'
import requests

url = "https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}"

payload = { "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>",
        "attributes": {
            "name": "<string>",
            "colour_palette": "purple",
            "colour_shade": "300",
            "description": "<string>"
        },
        "relationships": {
            "organisation": { "data": {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "type": "<string>"
                } },
            "template": {}
        }
    } }
headers = {
    "X-Session-Token": "<api-key>",
    "Content-Type": "application/vnd.api+json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      type: '<string>',
      attributes: {
        name: '<string>',
        colour_palette: 'purple',
        colour_shade: '300',
        description: '<string>'
      },
      relationships: {
        organisation: {data: {id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', type: '<string>'}},
        template: {}
      }
    }
  })
};

fetch('https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'type' => '<string>',
        'attributes' => [
                'name' => '<string>',
                'colour_palette' => 'purple',
                'colour_shade' => '300',
                'description' => '<string>'
        ],
        'relationships' => [
                'organisation' => [
                                'data' => [
                                                                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                                                                'type' => '<string>'
                                ]
                ],
                'template' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/vnd.api+json",
    "X-Session-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"colour_palette\": \"purple\",\n      \"colour_shade\": \"300\",\n      \"description\": \"<string>\"\n    },\n    \"relationships\": {\n      \"organisation\": {\n        \"data\": {\n          \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"type\": \"<string>\"\n        }\n      },\n      \"template\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Session-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/vnd.api+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}")
  .header("X-Session-Token", "<api-key>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"colour_palette\": \"purple\",\n      \"colour_shade\": \"300\",\n      \"description\": \"<string>\"\n    },\n    \"relationships\": {\n      \"organisation\": {\n        \"data\": {\n          \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"type\": \"<string>\"\n        }\n      },\n      \"template\": {}\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ctrl-hub.com/v3/operation-types/{operation_type_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"type\": \"<string>\",\n    \"attributes\": {\n      \"name\": \"<string>\",\n      \"colour_palette\": \"purple\",\n      \"colour_shade\": \"300\",\n      \"description\": \"<string>\"\n    },\n    \"relationships\": {\n      \"organisation\": {\n        \"data\": {\n          \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n          \"type\": \"<string>\"\n        }\n      },\n      \"template\": {}\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "description": "<string>"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "organisation": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "template": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "sandbox": true,
        "description": "<string>",
        "settings": {}
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "features": [
          {
            "name": "<string>",
            "enabled": true,
            "limit": 123
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "groups": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "nomenclature": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}
{
  "id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
  "status": "400",
  "title": "A validation error was encountered",
  "source": {
    "parameter": "include"
  },
  "meta": {
    "resource": "wrong_value"
  }
}
{
  "id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
  "status": "401",
  "title": "You are not authorised to access this resource",
  "detail": "In order to access this resource, you need the 'admin' role.",
  "code": "AUTH.001"
}
{
  "id": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
  "status": "404",
  "title": "Resource not found",
  "detail": "The requested resource could not be found or does not exist.",
  "code": "NOT_FOUND.001"
}
{
  "id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
  "status": "500",
  "title": "Internal Server Error",
  "detail": "An unexpected error occurred on the server."
}

Authorizations

​
X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

​
operation_type_id
string<uuid>
required

The unique identifier for the operation type.

Body

application/vnd.api+json

The operation type to update.

​
data
object
required

Response

The updated operation type.

JSON API response object

​
data
object
required

An operation type

​
jsonapi
object
required
​
included
object[]

Related resources that can be included when an operation type is returned

An organisation