Update a document group category
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroupCategories/{publicSectorDocumentGroupCategoriesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorDocumentGroupCategoriesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, DocumentGroupId and DocumentCategory ---for the Document Group Categories resource and used to uniquely identify an instance of Document Group Categories. The client should not generate the hash key value. Instead, the client should query on the Document Group Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Group Categories.
For example: publicSectorDocumentGroupCategories?q=AgencyId=<value1>;DocumentGroupId=<value2>;DocumentCategory=<value3>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorDocumentGroupCategories-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier for the public sector entity to which this document group category applies. -
CreationDate(optional):
string(date-time)
The date when the document category group was created.
-
DocumentCategory(optional):
string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category group. -
DocumentGroupId(optional):
string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag(optional):
boolean
Title:
Enabled
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(optional):
string(date-time)
The date when the document category group was last modified.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorDocumentGroupCategories-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier for the public sector entity to which this document group category applies. -
CreationDate(optional):
string(date-time)
The date when the document category group was created.
-
DocumentCategory(optional):
string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category group. -
DocumentGroupId(optional):
string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag(optional):
boolean
Title:
Enabled
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(optional):
string(date-time)
The date when the document category group was last modified.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.