Skip to main content
POST
/
api
/
handshake
/
search
searchForEntityWithBasicSearch
curl --request POST \
  --url https://api.artemis.cynopsis.co/api/handshake/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "searchText": "<string>",
  "sourceShortName": "<string>"
}
'
import requests

url = "https://api.artemis.cynopsis.co/api/handshake/search"

payload = {
    "searchText": "<string>",
    "sourceShortName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({searchText: '<string>', sourceShortName: '<string>'})
};

fetch('https://api.artemis.cynopsis.co/api/handshake/search', 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/handshake/search",
  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([
    'searchText' => '<string>',
    'sourceShortName' => '<string>'
  ]),
  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.artemis.cynopsis.co/api/handshake/search"

	payload := strings.NewReader("{\n  \"searchText\": \"<string>\",\n  \"sourceShortName\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.artemis.cynopsis.co/api/handshake/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"searchText\": \"<string>\",\n  \"sourceShortName\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/handshake/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"searchText\": \"<string>\",\n  \"sourceShortName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "content": [
    {
      "id": "<string>",
      "nameList": [
        "<string>"
      ],
      "type": "<string>",
      "uenList": [
        "<string>"
      ]
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

Authorization
string
header
required

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

Query Parameters

HandShakeAuth
string
required

HandShakeAuth

offset
integer<int64>
paged
boolean
pageNumber
integer<int32>
pageSize
integer<int32>
sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Body

application/json

request

searchText
string
required
sourceShortName
string
required

Response

OK

content
DataServiceSearchResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer<int32>
numberOfElements
integer<int32>
pageable
Pageable · object
size
integer<int32>
sort
Sort · object
totalElements
integer<int64>
totalPages
integer<int32>