update entity by id - Hacken

update entity by id

curl --request PUT \
  --url https://api.example.com/api/v1/organisation/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent": "ADGM",
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>",
  "tenantId": 123
}
'

import requests

url = "https://api.example.com/api/v1/organisation/{id}"

payload = {
    "name": "<string>",
    "parent": "ADGM",
    "icon": "<string>",
    "logoLight": "<string>",
    "darkLogo": "<string>",
    "tenantId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    parent: 'ADGM',
    icon: '<string>',
    logoLight: '<string>',
    darkLogo: '<string>',
    tenantId: 123
  })
};

fetch('https://api.example.com/api/v1/organisation/{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.example.com/api/v1/organisation/{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([
    'name' => '<string>',
    'parent' => 'ADGM',
    'icon' => '<string>',
    'logoLight' => '<string>',
    'darkLogo' => '<string>',
    'tenantId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/v1/organisation/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/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.example.com/api/v1/organisation/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/organisation/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "parent": "ADGM",
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>",
  "tenantId": 123
}

PUT

/

api

/

v1

/

organisation

/

{id}

update entity by id

curl --request PUT \
  --url https://api.example.com/api/v1/organisation/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "parent": "ADGM",
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>",
  "tenantId": 123
}
'

import requests

url = "https://api.example.com/api/v1/organisation/{id}"

payload = {
    "name": "<string>",
    "parent": "ADGM",
    "icon": "<string>",
    "logoLight": "<string>",
    "darkLogo": "<string>",
    "tenantId": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    parent: 'ADGM',
    icon: '<string>',
    logoLight: '<string>',
    darkLogo: '<string>',
    tenantId: 123
  })
};

fetch('https://api.example.com/api/v1/organisation/{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.example.com/api/v1/organisation/{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([
    'name' => '<string>',
    'parent' => 'ADGM',
    'icon' => '<string>',
    'logoLight' => '<string>',
    'darkLogo' => '<string>',
    'tenantId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/api/v1/organisation/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/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.example.com/api/v1/organisation/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/organisation/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"parent\": \"ADGM\",\n  \"icon\": \"<string>\",\n  \"logoLight\": \"<string>\",\n  \"darkLogo\": \"<string>\",\n  \"tenantId\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "parent": "ADGM",
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "icon": "<string>",
  "logoLight": "<string>",
  "darkLogo": "<string>",
  "tenantId": 123
}

Authorizations

Authorization

string

header

required

Authentication

Path Parameters

id

integer<int64>

required

Body

application/json

name

string

required

Regulator Organisation name

parent

string

required

Regulator Organisation parent

Example:

"ADGM"

status

enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:

ACTIVE,

DISABLED,

DELETED

icon

string

Regulator Organisation icon

logoLight

string

Regulator Organisation light logo

Pattern: \s*|^https?.*

darkLogo

string

Regulator Organisation dark logo

Pattern: \s*|^https?.*

tenantId

integer<int64>

Tenant ID corresponding to this organisation

Response

200 - application/json

OK

name

string

required

Regulator Organisation name

parent

string

required

Regulator Organisation parent

Example:

"ADGM"

id

integer<int64>

Unique identifier of the entity

Example:

1

createdAt

integer<int64>

Time when entity was created

updatedAt

integer<int64>

Time when entity was updated

status

enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:

ACTIVE,

DISABLED,

DELETED

icon

string

Regulator Organisation icon

logoLight

string

Regulator Organisation light logo

darkLogo

string

Regulator Organisation dark logo

tenantId

integer<int64>

Tenant ID corresponding to this organisation