ISisometric

Post Source

Changed on

Creates a source in the Isometric system. The client is provided with a presigned upload URL which must be used to upload the document associated with this source. Source documents are private, but other fields will be visible publicly once credits are issued for an associated removal, moving it to the public registry.

post/sources

Request

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

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Request body

supplier_reference_idstring 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.

__typename'CreateDocumentSourceRequest' required

Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.

display_namestring required
published_atstring date required

Date in ISO format (YYYY-MM-DD)

descriptionstring nullable

A description of the source document. Must be at most 2000 characters long.

is_publicboolean

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

file_namestring required

The full name of the file that will be uploaded, including its file extension

content_typestring required

The content type of the file that will be uploaded. This must also be passed as a Content-Type header during the upload. The pre-signed URL will only accept a file of this content-type. See the list of supported filetypes.

content_lengthinteger required

The size (in bytes) of the file that will be uploaded. The pre-signed URL will only accept a file of this size.

project_idstring required

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

Example request

{
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}

Response

Successful Response

signed_upload_urlstring required

A presigned upload URL, which must be used to upload the document associated with this source.

Example response

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

Changes

  • a29120dd7406Revision changes
    • breaking

      added the new required request property

    • breaking

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

    • info

      added the new optional request property

    • 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

  • 4f984b6745dbRevision changes
    • breaking

      removed the enum value application/geo+json of the request property

    • breaking

      removed the enum value application/json of the request property

    • breaking

      removed the enum value application/msword of the request property

    • breaking

      removed the enum value application/pdf of the request property

    • breaking

      removed the enum value application/vnd.ms-excel of the request property

    • breaking

      removed the enum value application/vnd.openxmlformats-officedocument.spreadsheetml.sheet of the request property

    • breaking

      removed the enum value application/vnd.openxmlformats-officedocument.wordprocessingml.document of the request property

    • breaking

      removed the enum value application/x-ipynb+json of the request property

    • breaking

      removed the enum value image/jpeg of the request property

    • breaking

      removed the enum value image/png of the request property

    • breaking

      removed the enum value text/csv of the request property

    • breaking

      removed the enum value text/plain of the request property

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the / response property's maxLength was increased from 36 to 37 for the response status

    • warning

      added the new WEBSITE enum value to the / response property for the response status