ISisometric

Patch Source

Changed on

Patches metadata associated with a source in the Isometric system.

patch/sources/{id}

Request

  • Base URL
    https://api.isometric.com/mrv/v0
  • URL
    https://api.isometric.com/mrv/v0/sources/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:src_1EBBF4M7X1S06G1Y

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Request body

Response

Successful Response

idstring required
supplier_reference_idstring nullable 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.

display_namestring nullable required
descriptionstring nullable required
original_filenamestring nullable required
type'DOCUMENT' | 'WEBSITE' required
published_atstring date nullable required
is_publicboolean required

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

project_idstring nullable required

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

Example response

{
  "id": "src_1EBBF4M7X1S06G1Y",
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}

Changes

  • e0d342ff70d6Revision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

  • a29120dd7406Revision changes
    • breaking

      the / response property's maxLength was increased from 100 to 200 for the response status

    • info

      added the new optional request property

    • info

      for the path request parameter id, the type was generalized from string to no type

    • info

      the / request property's maxLength was increased from 100 to 150

    • info

      the / request property's maxLength was increased from 100 to 200

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status