Finds items by container ID and/or sequence number.

POST /api/item/find

Finds items by container ID and/or sequence number.

cURL

curl --request POST \
  --url https://{install}/api/item/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "containerId": "<string>",
  "sequence": 123
}
'

import requests

url = "https://{install}/api/item/find"

payload = {
    "containerId": "<string>",
    "sequence": 123
}
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({containerId: '<string>', sequence: 123})
};

fetch('https://{install}/api/item/find', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/item/find");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"containerId\": \"<string>\",\n  \"sequence\": 123\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/item/find",
  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([
    'containerId' => '<string>',
    'sequence' => 123
  ]),
  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://{install}/api/item/find"

	payload := strings.NewReader("{\n  \"containerId\": \"<string>\",\n  \"sequence\": 123\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://{install}/api/item/find")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"containerId\": \"<string>\",\n  \"sequence\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/item/find")

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  \"containerId\": \"<string>\",\n  \"sequence\": 123\n}"

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

200

[
  {
    "entity": "<string>",
    "containerId": "<string>",
    "processId": "<string>",
    "sequence": 123,
    "boardId": "<string>",
    "cycleId": "<string>",
    "resourceType": 123,
    "resourceId": "<string>",
    "dateOpened": "2023-11-07T05:31:56Z",
    "dateWorking": "2023-11-07T05:31:56Z",
    "dateClosed": "2023-11-07T05:31:56Z",
    "time": [
      {
        "id": "<string>",
        "dated": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "timeTypeId": "<string>",
        "timeLogged": "<string>",
        "comment": "<string>",
        "status": 123
      }
    ],
    "field": [
      {
        "fieldId": "<string>",
        "data": "<string>"
      }
    ],
    "meta": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "clockStart": "2023-11-07T05:31:56Z",
    "clockFinish": "2023-11-07T05:31:56Z",
    "clockDelta": 123,
    "clockHours": 123,
    "clockStatus": 123,
    "dependencyKey": "<string>",
    "dependencyIndent": 123,
    "dependencyChild": 123,
    "tenantId": "<string>",
    "id": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updated": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "deleted": true
  }
]

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

application/jsonapplication/*+json

The container ID and sequence number to search by.

containerId · string

sequence · integer<int32>

Response

200

application/json

List of matching items.

entity · null | string

containerId · string

processId · string

sequence · integer<int32>

boardId · string

cycleId · string

resourceType · integer

resourceId · string

dateOpened · null | string<date-time>

dateWorking · null | string<date-time>

dateClosed · null | string<date-time>

time · object[]

Show child attributes

field · object[]

Show child attributes

meta · object[]

Show child attributes

clockStart · string<date-time>

clockFinish · string<date-time>

clockDelta · number<double>

clockHours · integer<int32>

clockStatus · integer

dependencyKey · string

dependencyIndent · integer<int32>

dependencyChild · integer<int32>

tenantId · string

id · string

created · string<date-time>

createdBy · string

updated · string<date-time>

updatedBy · string

deleted · boolean