Skip to main content
PATCH
/
sources
/
{id}
Patch Source
curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/sources/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "display_name": {
    "__typename": "Undefined"
  },
  "is_public": {
    "__typename": "Undefined"
  },
  "published_at": {
    "__typename": "Undefined"
  },
  "supplier_reference_id": {
    "__typename": "Undefined"
  }
}
'
{
  "display_name": "<string>",
  "id": "src_1EBBF4M7X1S06G1Y",
  "is_public": true,
  "original_filename": "<string>",
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "published_at": "2023-12-25",
  "supplier_reference_id": "<string>",
  "type": "DOCUMENT",
  "url_info": {
    "url": "<string>",
    "__typename": "SourcePublicUrlInfo"
  }
}

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required
Required string length: 20 - 37
Examples:

"src_1EBBF4M7X1S06G1Y"

"src_1DW1B17VNSBX37N0"

Body

application/json
​
display_name
default:{"__typename":"Undefined"}
Required string length: 1 - 100
​
is_public
default:{"__typename":"Undefined"}

If the source document should be publicly available on the Registry once credits are issued.

​
published_at
default:{"__typename":"Undefined"}

Date in ISO format (YYYY-MM-DD)

​
supplier_reference_id
default:{"__typename":"Undefined"}

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 100

Response

Successful Response

​
display_name
string | null
required
​
id
string
required
Required string length: 20 - 37
Examples:

"src_1EBBF4M7X1S06G1Y"

"src_1DW1B17VNSBX37N0"

​
is_public
boolean
required

This field indicates Whether or not this source document will be public on the Registry once Credits are issued referencing it.

​
original_filename
string | null
required
​
project_id
string | null
required

The ID of the project that the source is associated with.

Required string length: 20 - 37
Example:

"prj_1CTWZQGKE1S0VAXA"

​
published_at
string<date> | null
required
​
supplier_reference_id
string | null
required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

Required string length: 1 - 100
​
type
enum<string>
required
Available options:
DOCUMENT,
WEBSITE
​
url_info
SourcePublicUrlInfo · object
required

URL info for the source, that varies depending on if it is public or private