IQSMS API
Fetch documents list
GET
/iqsms/documents |
Response - List of document metadata entities
Document metadata
Field | Type | Description |
documentId | uuid | Unique identifier of the document |
revisionId | uuid | Unique identifier of the revision |
effectiveFrom | date in format YYYY-MM-DDThh:mmZ | Date from which this revision becomes effective |
owner | string | Document owner |
manualName | string | Name of the document |
revisionName | string | Name of the revision |
contextExternalKey | object {"externalId", “source”} | External reference information for particular source types. |
Errors
Code | Error |
---|---|
200 | Success |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Fetch legal references
GET
/iqsms/legal-references |
Response - List of relations between modules and IQSMS documents
Document metadata
Field | Type | Description |
documentId | uuid | Unique identifier of the document |
revisionId | uuid | Unique identifier of the revision |
effectiveFrom | date in format YYYY-MM-DDThh:mmZ | Date from which this revision becomes effective |
regulationId | string | Unique identifier of the regulation |
amendmentId | string | Unique identifier of the amendment |
originalParagraphId | string | Unique identifier of the paragraph |
manualName | string | IQSMS manual name |
revisionName | string | IQSMS revision name |
heading | string | Linked heading |
viewUrl | string | Url to the Yonder source Module |
Errors
Code | Error |
---|---|
200 | Success |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |