Update a document group
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorDocumentGroupsUniqID: integer
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>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorDocumentGroups-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this document group applies. -
CreationDate(optional):
string(date-time)
The timestamp on which the document group was created.
-
Description(optional):
string
Title:
Description
Maximum Length:500
Indicates the value that will describe the document group. -
DocumentGroup(optional):
string
Title:
Group
Maximum Length:25
Indicates the value that will be displayed for document group. -
DocumentGroupCategory(optional):
array Document Group Categories
Title:
Document Group Categories
Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with. -
DocumentGroupId(optional):
string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates if the document group is enabled or not for selection in attachments. If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected. Default value is false. -
LastUpdateDate(optional):
string(date-time)
The timestamp on which the document group was last modified.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : Document Group Categories
Type:
array
Title:
Document Group Categories
Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.
Show Source
Nested Schema : publicSectorDocumentGroups-DocumentGroupCategory-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of 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 : publicSectorDocumentGroups-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this document group applies. -
CreationDate(optional):
string(date-time)
The timestamp on which the document group was created.
-
Description(optional):
string
Title:
Description
Maximum Length:500
Indicates the value that will describe the document group. -
DocumentGroup(optional):
string
Title:
Group
Maximum Length:25
Indicates the value that will be displayed for document group. -
DocumentGroupCategory(optional):
array Document Group Categories
Title:
Document Group Categories
Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with. -
DocumentGroupId(optional):
string
Title:
Group ID
Maximum Length:30
The unique identifier for the document group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates if the document group is enabled or not for selection in attachments. If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected. Default value is false. -
LastUpdateDate(optional):
string(date-time)
The timestamp on which the document group was last modified.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : Document Group Categories
Type:
array
Title:
Document Group Categories
Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.
Show Source
Nested Schema : publicSectorDocumentGroups-DocumentGroupCategory-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of 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.