Register source objects from a storage connection

POST

api

sources

curl --request POST \
  --url https://api.nitsor.com/api/v1/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "objectKeys": [
    "<string>"
  ],
  "storageConnectionId": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/sources"

payload = {
    "idempotencyKey": "<string>",
    "objectKeys": ["<string>"],
    "storageConnectionId": "<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({
    idempotencyKey: '<string>',
    objectKeys: ['<string>'],
    storageConnectionId: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/sources', 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.nitsor.com/api/v1/sources",
  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([
    'idempotencyKey' => '<string>',
    'objectKeys' => [
        '<string>'
    ],
    'storageConnectionId' => '<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.nitsor.com/api/v1/sources"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<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.nitsor.com/api/v1/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/sources")

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  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<string>\"\n}"

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

{
  "accountId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "issues": [
    {
      "code": "ACCOUNT_NOT_FOUND",
      "message": "<string>",
      "remediation": "<string>",
      "fieldPath": "<string>"
    }
  ],
  "manifest": [
    {
      "errors": [
        {
          "code": "ACCOUNT_NOT_FOUND",
          "message": "<string>",
          "remediation": "<string>",
          "fieldPath": "<string>"
        }
      ],
      "objectKey": "<string>",
      "status": "registered",
      "byteSize": 1,
      "checksum": "<string>",
      "contentFingerprint": "<string>",
      "etag": "<string>",
      "etagWeak": true,
      "instanceNumber": 123,
      "pixelDataByteOffset": 1,
      "positionMm": 123,
      "role": "descriptor",
      "sopInstanceUid": "<string>"
    }
  ],
  "registeredFileCount": 1,
  "rejectedFileCount": 1,
  "sourceId": "<string>",
  "sourceFormat": "dicom",
  "sourceObjectCount": 123,
  "sourceVersionId": "<string>",
  "status": "registered",
  "storageConnectionId": "<string>",
  "geometry": {
    "kind": "dicom",
    "bitsAllocated": 123,
    "bitsStored": 123,
    "columns": 123,
    "highBit": 1,
    "imageOrientationPatient": [
      123
    ],
    "modality": "<string>",
    "photometricInterpretation": "<string>",
    "pixelRepresentation": 0,
    "pixelSpacing": [
      123
    ],
    "rescaleIntercept": 123,
    "rescaleSlope": 123,
    "rows": 123,
    "sliceSpacing": 1,
    "transferSyntaxUid": "<string>",
    "windowCenter": 123,
    "windowWidth": 1,
    "frames": {
      "axis": "time",
      "count": 3,
      "frameTimeMs": 1
    },
    "frameOfReferenceUid": "<string>",
    "orientationSource": "image-plane",
    "spacingSource": "pixel-spacing"
  },
  "viewability": "viewable",
  "arrival": "api",
  "credentialKind": "person",
  "seriesInstanceUid": "<string>",
  "studyInstanceUid": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

Authorizations

Authorization

string

header

required

An Agent credential (nits_…), or a person token (nitp_…) on a deployment that enables them. GET /api/v1/session names the principal a credential proves.

Body

application/json

idempotencyKey

string

required

Required string length: 1 - 200

objectKeys

string[]

required

Required array length: 1 - 520 elements

Required string length: 1 - 1024

storageConnectionId

string

required

Required string length: 1 - 200

Response

Option 1
Option 2
Option 3

accountId

string

required

Minimum string length: 1

createdAt

string<date-time>

required

RFC 3339 timestamp in UTC: the offset is Z or +00:00; any other offset is refused.

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|[+-]00:00))$

issues

object[]

required

Maximum array length: 32

Show child attributes

manifest

object[]

required

Maximum array length: 520

Show child attributes

registeredFileCount

integer

required

Required range: x >= 0

rejectedFileCount

integer

required

Required range: x >= 0

sourceId

string

required

Pattern: ^sha256:([0-9a-f]{64})$

sourceFormat

enum<string>

required

Available options:

dicom,

mrd,

projection-stack,

tiff-stack,

vgi-vol,

nsi-legacy,

nsi-hrvol,

rek,

flt,

cb,

sbm

sourceObjectCount

integer

required

Required range: x <= 520

sourceVersionId

string

required

Pattern: ^sha256:([0-9a-f]{64})$

status

enum<string>

required

Available options:

registered,

partial_failure

storageConnectionId

string

required

Required string length: 1 - 200

geometry

object

required

Option 1
Option 2
Option 3

Show child attributes

viewability

string

required

Allowed value: "viewable"

arrival

enum<string>

How this Source first arrived. api, cli, sdk-typescript and sdk-python are reported by the client in its Nitsor-Client header, and a request without a recognised one records api: they describe a cooperative caller and prove nothing. cli and sdk-typescript come from earlier clients that are no longer published; the Python SDK reports sdk-python. manual-upload, seed, demo and system are written by the server and no header can claim them. Later arrivals of the same bytes do not change it. unknown marks a Source registered before arrivals were recorded. Absent only from servers older than this field.

Available options:

api,

cli,

sdk-typescript,

sdk-python,

manual-upload,

seed,

demo,

system,

unknown

credentialKind

enum<string>

The kind of credential that authenticated the first arrival, established by the server: person (a signed-in session or a person token), agent (an Agent credential) or system (deployment access, which the seed and demo runs use). unknown marks a Source registered before it was recorded. Absent only from servers older than this field.

Available options:

person,

agent,

system,

unknown

seriesInstanceUid

string

Minimum string length: 1

studyInstanceUid

string

Minimum string length: 1

curl --request POST \
  --url https://api.nitsor.com/api/v1/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "objectKeys": [
    "<string>"
  ],
  "storageConnectionId": "<string>"
}
'

import requests

url = "https://api.nitsor.com/api/v1/sources"

payload = {
    "idempotencyKey": "<string>",
    "objectKeys": ["<string>"],
    "storageConnectionId": "<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({
    idempotencyKey: '<string>',
    objectKeys: ['<string>'],
    storageConnectionId: '<string>'
  })
};

fetch('https://api.nitsor.com/api/v1/sources', 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.nitsor.com/api/v1/sources",
  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([
    'idempotencyKey' => '<string>',
    'objectKeys' => [
        '<string>'
    ],
    'storageConnectionId' => '<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.nitsor.com/api/v1/sources"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<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.nitsor.com/api/v1/sources")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nitsor.com/api/v1/sources")

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  \"idempotencyKey\": \"<string>\",\n  \"objectKeys\": [\n    \"<string>\"\n  ],\n  \"storageConnectionId\": \"<string>\"\n}"

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

{
  "accountId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "issues": [
    {
      "code": "ACCOUNT_NOT_FOUND",
      "message": "<string>",
      "remediation": "<string>",
      "fieldPath": "<string>"
    }
  ],
  "manifest": [
    {
      "errors": [
        {
          "code": "ACCOUNT_NOT_FOUND",
          "message": "<string>",
          "remediation": "<string>",
          "fieldPath": "<string>"
        }
      ],
      "objectKey": "<string>",
      "status": "registered",
      "byteSize": 1,
      "checksum": "<string>",
      "contentFingerprint": "<string>",
      "etag": "<string>",
      "etagWeak": true,
      "instanceNumber": 123,
      "pixelDataByteOffset": 1,
      "positionMm": 123,
      "role": "descriptor",
      "sopInstanceUid": "<string>"
    }
  ],
  "registeredFileCount": 1,
  "rejectedFileCount": 1,
  "sourceId": "<string>",
  "sourceFormat": "dicom",
  "sourceObjectCount": 123,
  "sourceVersionId": "<string>",
  "status": "registered",
  "storageConnectionId": "<string>",
  "geometry": {
    "kind": "dicom",
    "bitsAllocated": 123,
    "bitsStored": 123,
    "columns": 123,
    "highBit": 1,
    "imageOrientationPatient": [
      123
    ],
    "modality": "<string>",
    "photometricInterpretation": "<string>",
    "pixelRepresentation": 0,
    "pixelSpacing": [
      123
    ],
    "rescaleIntercept": 123,
    "rescaleSlope": 123,
    "rows": 123,
    "sliceSpacing": 1,
    "transferSyntaxUid": "<string>",
    "windowCenter": 123,
    "windowWidth": 1,
    "frames": {
      "axis": "time",
      "count": 3,
      "frameTimeMs": 1
    },
    "frameOfReferenceUid": "<string>",
    "orientationSource": "image-plane",
    "spacingSource": "pixel-spacing"
  },
  "viewability": "viewable",
  "arrival": "api",
  "credentialKind": "person",
  "seriesInstanceUid": "<string>",
  "studyInstanceUid": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}

{
  "requestId": "<string>",
  "retryable": true,
  "code": "AUTHORIZATION_DENIED",
  "message": "<string>",
  "missingScope": "<string>",
  "reason": "<string>",
  "decisionId": "<string>"
}