v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Post Monitoring Submission

Creates a monitoring submission for a project monitoring requirement.

The submission is associated with a previously uploaded source document (see Post Source). One source may be used to create multiple submissions.

post/projects/{project_id}/monitoring_requirements/{id}/submissions

Path parameters

project_idstring required
Example:prj_1CTWZQGKE1S0VAXA
idstring required
Example:mnr_1DJJQY5C61S0R519

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Request body

source_idstring required

The Isometric ID of the source that the submission is for.

valid_fromstring date-time required

Signifies the start of the period that the submission is valid for.

valid_tostring date-time required

Signifies the end of the period that the submission is valid for.

supplier_reference_idstring nullable

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.

notesstring nullable

Free-text notes for the monitoring submission. Must be at most 300 characters long.

Example request

{
  "source_id": "src_1EBBF4M7X1S06G1Y",
  "notes": "Pages 14-21"
}

Response

Successful Response

idstring required
source_idstring required
valid_fromstring date-time nullable required
valid_tostring date-time 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.

notesstring nullable required

Example response

{
  "id": "mns_1D46WGW6A1S03FRG",
  "source_id": "src_1EBBF4M7X1S06G1Y"
}