Skip to content
CCPEDIAby Unity Nodes

Post apiutilitiesv0contractinstrument configuration

POST
/
api
/
utilities
/
v0
/
contract
/
instrument-configuration
Try it
cURL

cURL

curl --request POST \
  --url https://api.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration \
  --header 'Content-Type: application/json' \
  --data '
{
  "registrar": "<string>",
  "instrumentIdentifier": {
    "source": "<string>",
    "id": "<string>",
    "scheme": "<string>"
  }
}
'
import requests

url = "https://api.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration"

payload = {
    "registrar": "<string>",
    "instrumentIdentifier": {
        "source": "<string>",
        "id": "<string>",
        "scheme": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    registrar: '<string>',
    instrumentIdentifier: {source: '<string>', id: '<string>', scheme: '<string>'}
  })
};

fetch('https://api.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration', 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.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'registrar' => '<string>',
    'instrumentIdentifier' => [
        'source' => '<string>',
        'id' => '<string>',
        'scheme' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "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.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration"

	payload := strings.NewReader("{\n  \"registrar\": \"<string>\",\n  \"instrumentIdentifier\": {\n    \"source\": \"<string>\",\n    \"id\": \"<string>\",\n    \"scheme\": \"<string>\"\n  }\n}")

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

	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.post("https://api.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration")
  .header("Content-Type", "application/json")
  .body("{\n  \"registrar\": \"<string>\",\n  \"instrumentIdentifier\": {\n    \"source\": \"<string>\",\n    \"id\": \"<string>\",\n    \"scheme\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.utilities.digitalasset.com/api/utilities/v0/contract/instrument-configuration")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"registrar\": \"<string>\",\n  \"instrumentIdentifier\": {\n    \"source\": \"<string>\",\n    \"id\": \"<string>\",\n    \"scheme\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
200
404
500
{
  "contract": {
    "contractId": "<string>",
    "templateId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "synchronizerId": "<string>",
    "domainId": "<string>"
  },
  "payload": {
    "operator": "<string>",
    "provider": "<string>",
    "registrar": "<string>",
    "defaultIdentifier": {
      "source": "<string>",
      "id": "<string>",
      "scheme": "<string>"
    },
    "additionalIdentifiers": [
      {
        "source": "<string>",
        "id": "<string>",
        "scheme": "<string>"
      }
    ],
    "issuerRequirements": [
      {
        "issuer": "<string>",
        "requiredClaims": "<string>"
      }
    ],
    "holderRequirements": [
      {
        "issuer": "<string>",
        "requiredClaims": "<string>"
      }
    ]
  }
}
{
  "error": "unknown_error",
  "error_description": "Something went wrong"
}
{
  "error": "unknown_error",
  "error_description": "Something went wrong"
}

Body

application/json
registrar
string
required

The registrar party id

instrumentIdentifier
object
required

Show child attributes

Response

200
application/json

Returns the instrument configuration

contract
object
required

Show child attributes

payload
object
required

Show child attributes