Create a document group category
post
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}/child/DocumentGroupCategory
Request
Path Parameters
-
publicSectorDocumentGroupsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and DocumentGroupId ---for the Document Groups resource and used to uniquely identify an instance of Document Groups. The client should not generate the hash key value. Instead, the client should query on the Document Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Groups.
For example: publicSectorDocumentGroups?q=AgencyId=<value1>;DocumentGroupId=<value2>
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this document group category applies. -
DocumentCategory: string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category group. -
DocumentGroupId: string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorDocumentGroups-DocumentGroupCategory-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this document group category applies. -
CreationDate: string
(date-time)
Read Only:
true
The date when the document category group was created. -
DocumentCategory: string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category group. -
DocumentGroupId: string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the document category group was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.