Get a single document group by ID.
Version 2.0.0
Endpoint
GET
undefined/document-groups/{id}
Copy
Provides a single documentGroup details.
Path Parameters
- idstringRequiredThe ID of the document group.
Body Parameters
Responses
successful operation.
Body
application/json
- objectDocumentGroup(s) are the equivalent of ApplicationGroup within CMOD. They provide a category into which to place archived documents and include the definition of certain parameters/settings for the group – such as Retention Period, as well as the definition of metadata items to be set for documents being associated with the group. The DocumentGroup into which to place an uploaded document must be specified upon upload.
- idstringPOST - Auto generated. PUT - When provided, must match with the id in the url.Example: g1
- namestringRequiredPOST – required - Must be unique, PUT – identifier – cannot be changed. Allowed characters: alphanumeric (a-z, A-Z, 0-9), underscore '_' and dash '-'Example: contractsLength: 256
- descriptionstringOptional. A more descriptive field to the group name. Allowed characters: alphanumeric (a-z, A-Z, 0-9), underscore '_', dash '-' and space ' '.Example: Special ContractsLength: 256
- forceAllMetadatabooleanOptional. Default: false. When set to true, forces all metadata of the documentGroup fields to be sent (even with null value) when uploading a document, otherwise an error is returned. When set to false, at least one metadata item matching the documentGroup should be sent, otherwise an error.Example: true
- creationDatestringRead-only. The date the documentGroup was first created.Example: 2023-11-20
- lastUpdatedstringRead-only. The date the documentGroup was last updated.Example: 2024-03-08
- retentionPeriodint64RequiredDefines the document retention period in months.Example: 61
- legalHoldbooleanOptional: Default: true. When set to true, prevents retiring documents under this documentGroup. When legalHoldStartDate, legalHoldEndDate are set and value is true, only documents within these dates are not purged upon retirement. When set to false, documents will purge upon retentionPeriod disregarding the legal hold dates.Example: false
- legalHoldStartDatestringOptional: MM/DD/YYYY. When set and legalHold=true, documents, which retention field date >= that date, will not delete on retention.Example: 2020-12-30
- legalHoldEndDatestringOptional: MM/DD/YYYY. When set and legalHold=true, documents, which retention field date <= that date, will not delete on retention.Example: 2021-02-15
- retentionEoybooleanOptional. Default: false. When set to true, forces the retention process to retire the files at the end of the year they supposed to retire on (e.g. a file that should retire on May 2023 will be purged on December 31 of that year. When set to false, the file will be deleted on the date it was set to retire).Example: true
- fieldsarray of objectsRequired
Definition of the metadata to load with each document.
An item in an array of metadata definition of documentGroup.