POST /registry/transfer-instruction/v1/:transferInstructionId/choice-contexts/withdraw

curl --request POST \
  --url https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw \
  --header 'Content-Type: application/json' \
  --data '
{
  "meta": {},
  "excludeDebugFields": false
}
'

import requests

url = "https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw"

payload = {
    "meta": {},
    "excludeDebugFields": False
}
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({meta: {}, excludeDebugFields: false})
};

fetch('https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw', 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/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw",
  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([
    'meta' => [
        
    ],
    'excludeDebugFields' => false
  ]),
  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.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw"

	payload := strings.NewReader("{\n  \"meta\": {},\n  \"excludeDebugFields\": false\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.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {},\n  \"excludeDebugFields\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw")

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  \"meta\": {},\n  \"excludeDebugFields\": false\n}"

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

{
  "choiceContextData": {},
  "disclosedContracts": [
    {
      "templateId": "<string>",
      "contractId": "<string>",
      "createdEventBlob": "<string>",
      "synchronizerId": "<string>",
      "debugPackageName": "<string>",
      "debugPayload": {},
      "debugCreatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

registry

transfer-instruction

{transferInstructionId}

choice-contexts

withdraw

POST /registry/transfer-instruction/v1/:transferInstructionId/choice-contexts/withdraw

curl --request POST \
  --url https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw \
  --header 'Content-Type: application/json' \
  --data '
{
  "meta": {},
  "excludeDebugFields": false
}
'

import requests

url = "https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw"

payload = {
    "meta": {},
    "excludeDebugFields": False
}
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({meta: {}, excludeDebugFields: false})
};

fetch('https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw', 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/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw",
  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([
    'meta' => [
        
    ],
    'excludeDebugFields' => false
  ]),
  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.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw"

	payload := strings.NewReader("{\n  \"meta\": {},\n  \"excludeDebugFields\": false\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.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw")
  .header("Content-Type", "application/json")
  .body("{\n  \"meta\": {},\n  \"excludeDebugFields\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw")

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  \"meta\": {},\n  \"excludeDebugFields\": false\n}"

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

{
  "choiceContextData": {},
  "disclosedContracts": [
    {
      "templateId": "<string>",
      "contractId": "<string>",
      "createdEventBlob": "<string>",
      "synchronizerId": "<string>",
      "debugPackageName": "<string>",
      "debugPayload": {},
      "debugCreatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Path Parameters

transferInstructionId

string

required

The contract ID of the transfer instruction to withdraw.

Body

application/json

A request to get the context for executing a choice on a contract.

Response

The context required to exercise a choice on a contract via an interface. Used to retrieve additional reference data that is passed in via disclosed contracts, which are in turn referred to via their contract ID in the choiceContextData.

choiceContextData

object

required

The additional data to use when exercising the choice.

disclosedContracts

object[]

required

The contracts that are required to be disclosed to the participant node for exercising the choice.

Show child attributes

⌘I

Ledger API

Daml Standard Library

Daml Script

TypeScript

dApp API

Wallet Gateway

Splice APIs

Admin API

POST /registry/transfer-instruction/v1/:transferInstructionId/choice-contexts/withdraw

Path Parameters

Body

Response