Skip to main content
POST
/
api
/
own-restricted-list
/
{listId}
/
name
addRestrictedName
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Domain-ID: <x-domain-id>' \
  --data '
{
  "name": "<string>",
  "comment": "<string>",
  "country": "<string>",
  "dateInfo": "2023-11-07T05:31:56Z",
  "idNumber": "<string>",
  "referenceNumber": "<string>"
}
'
import requests

url = "https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name"

payload = {
"name": "<string>",
"comment": "<string>",
"country": "<string>",
"dateInfo": "2023-11-07T05:31:56Z",
"idNumber": "<string>",
"referenceNumber": "<string>"
}
headers = {
"X-Domain-ID": "<x-domain-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'X-Domain-ID': '<x-domain-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
comment: '<string>',
country: '<string>',
dateInfo: '2023-11-07T05:31:56Z',
idNumber: '<string>',
referenceNumber: '<string>'
})
};

fetch('https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name', 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.artemis.cynopsis.co/api/own-restricted-list/{listId}/name",
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>',
'comment' => '<string>',
'country' => '<string>',
'dateInfo' => '2023-11-07T05:31:56Z',
'idNumber' => '<string>',
'referenceNumber' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Domain-ID: <x-domain-id>"
],
]);

$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.artemis.cynopsis.co/api/own-restricted-list/{listId}/name"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"country\": \"<string>\",\n \"dateInfo\": \"2023-11-07T05:31:56Z\",\n \"idNumber\": \"<string>\",\n \"referenceNumber\": \"<string>\"\n}")

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

req.Header.Add("X-Domain-ID", "<x-domain-id>")
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.post("https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name")
.header("X-Domain-ID", "<x-domain-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"country\": \"<string>\",\n \"dateInfo\": \"2023-11-07T05:31:56Z\",\n \"idNumber\": \"<string>\",\n \"referenceNumber\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/own-restricted-list/{listId}/name")

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

request = Net::HTTP::Post.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"country\": \"<string>\",\n \"dateInfo\": \"2023-11-07T05:31:56Z\",\n \"idNumber\": \"<string>\",\n \"referenceNumber\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "comment": "<string>",
  "country": "<string>",
  "createdAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "createdBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  },
  "dateInfo": "2023-11-07T05:31:56Z",
  "id": 123,
  "idNumber": "<string>",
  "name": "<string>",
  "referenceNumber": "<string>",
  "updatedAt": {
    "date": 123,
    "day": 123,
    "hours": 123,
    "minutes": 123,
    "month": 123,
    "nanos": 123,
    "seconds": 123,
    "time": 123,
    "timezoneOffset": 123,
    "year": 123
  },
  "updatedBy": {
    "email": "<string>",
    "firstName": "<string>",
    "fullName": "<string>",
    "id": 123,
    "lastName": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Path Parameters

listId
integer<int64>
required

listId

Body

application/json

requestDto

name
string
required
comment
string
country
string
dateInfo
string<date-time>
idNumber
string
referenceNumber
string

Response

OK

comment
string
country
string
createdAt
Timestamp · object
createdBy
UserInfo · object
dateInfo
string<date-time>
id
integer<int64>
idNumber
string
name
string
referenceNumber
string
updatedAt
Timestamp · object
updatedBy
UserInfo · object