Creates one or more compliance custom field definitions.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": true,
"isMandatory": true,
"isMultiLine": true,
"isSortByAllowedValueId": true,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": true
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"
payload = [
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": True,
"isMandatory": True,
"isMultiLine": True,
"isSortByAllowedValueId": True,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": True
}
]
}
]
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([
{
name: '<string>',
userDefinedId: '<string>',
position: 123,
internalOnly: true,
isMandatory: true,
isMultiLine: true,
isSortByAllowedValueId: true,
maxChar: 123,
allowedDecimals: 123,
parentCustomFieldId: 123,
allowedValues: [{id: 123, value: '<string>', userDefinedId: '<string>', isDefaultValue: true}]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields",
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([
[
'name' => '<string>',
'userDefinedId' => '<string>',
'position' => 123,
'internalOnly' => true,
'isMandatory' => true,
'isMultiLine' => true,
'isSortByAllowedValueId' => true,
'maxChar' => 123,
'allowedDecimals' => 123,
'parentCustomFieldId' => 123,
'allowedValues' => [
[
'id' => 123,
'value' => '<string>',
'userDefinedId' => '<string>',
'isDefaultValue' => true
]
]
]
]),
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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
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 {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"type": "allowedValue",
"state": "active",
"position": 123,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"parentCustomFieldName": "<string>",
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"properties": [
"<string>"
]
}
],
"properties": [
"<string>"
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}ComplianceCustomFields
Creates one or more compliance custom field definitions.
Body is always an array, even for a single item. All items are persisted in a single transaction (all-or-nothing). Capped at 200 items per request.
POST
/
api
/
compliance-custom-fields
Creates one or more compliance custom field definitions.
curl --request POST \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields \
--header 'Content-Type: application/json' \
--data '
[
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": true,
"isMandatory": true,
"isMultiLine": true,
"isSortByAllowedValueId": true,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": true
}
]
}
]
'import requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"
payload = [
{
"name": "<string>",
"userDefinedId": "<string>",
"position": 123,
"internalOnly": True,
"isMandatory": True,
"isMultiLine": True,
"isSortByAllowedValueId": True,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"isDefaultValue": True
}
]
}
]
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([
{
name: '<string>',
userDefinedId: '<string>',
position: 123,
internalOnly: true,
isMandatory: true,
isMultiLine: true,
isSortByAllowedValueId: true,
maxChar: 123,
allowedDecimals: 123,
parentCustomFieldId: 123,
allowedValues: [{id: 123, value: '<string>', userDefinedId: '<string>', isDefaultValue: true}]
}
])
};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields', 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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields",
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([
[
'name' => '<string>',
'userDefinedId' => '<string>',
'position' => 123,
'internalOnly' => true,
'isMandatory' => true,
'isMultiLine' => true,
'isSortByAllowedValueId' => true,
'maxChar' => 123,
'allowedDecimals' => 123,
'parentCustomFieldId' => 123,
'allowedValues' => [
[
'id' => 123,
'value' => '<string>',
'userDefinedId' => '<string>',
'isDefaultValue' => true
]
]
]
]),
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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields"
payload := strings.NewReader("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\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://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
.header("Content-Type", "application/json")
.body("[\n {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\n }\n]")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/compliance-custom-fields")
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 {\n \"name\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"position\": 123,\n \"internalOnly\": true,\n \"isMandatory\": true,\n \"isMultiLine\": true,\n \"isSortByAllowedValueId\": true,\n \"maxChar\": 123,\n \"allowedDecimals\": 123,\n \"parentCustomFieldId\": 123,\n \"allowedValues\": [\n {\n \"id\": 123,\n \"value\": \"<string>\",\n \"userDefinedId\": \"<string>\",\n \"isDefaultValue\": true\n }\n ]\n }\n]"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"userDefinedId": "<string>",
"type": "allowedValue",
"state": "active",
"position": 123,
"maxChar": 123,
"allowedDecimals": 123,
"parentCustomFieldId": 123,
"parentCustomFieldName": "<string>",
"allowedValues": [
{
"id": 123,
"value": "<string>",
"userDefinedId": "<string>",
"properties": [
"<string>"
]
}
],
"properties": [
"<string>"
]
}
]
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"operation": "<string>",
"total_items": 123,
"failed_items": 123,
"summary": "<string>",
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Body
application/jsontext/jsonapplication/*+json
Display name of the compliance custom field. Required.
Customer-defined identifier for the field, used in integrations. Optional.
Field type that controls the input control and validation. Set at creation and cannot be changed afterwards.
Available options:
allowedValue, date, text, nestedAllowedValue, numeric, divider Display order of the field within the compliance custom fields panel. Lower values appear first. Required.
Initial lifecycle state of the field. Defaults to active.
Available options:
active, inactive, deleted When true, the field is visible to brand users only and hidden from supplier users. Defaults to false.
When true, the field must be filled in before the certificate can be submitted. Defaults to false.
When true, a text-type field is rendered as a multi-line text area. Defaults to false.
When true, allowed values are ordered by their insertion order rather than alphabetically. Defaults to false.
Maximum character length allowed for a text-type field. Leave null for no limit.
Number of decimal places allowed for a numeric-type field. Defaults to 0 for whole numbers.
Identifier of the parent field. Required for nestedAllowedValue children and null for all other types.
Initial selectable options for allowedValue and nestedAllowedValue fields. Null or omitted creates the field with no options.
Show child attributes
Show child attributes
Response
Created
The coarse outcome of the request, indicating whether it succeeded or failed.
Available options:
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.
Show child attributes
Show child attributes