Update a document subcategory
patch
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentCategories/{publicSectorDocumentCategoriesUniqID}/child/DocumentSubcategory/{DocumentSubcategoryUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
DocumentSubcategoryUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, DocumentCategory and DocumentSubcategory ---for the Document Subcategories resource and used to uniquely identify an instance of Document Subcategories. The client should not generate the hash key value. Instead, the client should query on the Document Subcategories collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Subcategories.
For example: DocumentSubcategory?q=AgencyId=<value1>;DocumentCategory=<value2>;DocumentSubcategory=<value3> -
publicSectorDocumentCategoriesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and DocumentCategory ---for the Document Categories resource and used to uniquely identify an instance of Document Categories. The client should not generate the hash key value. Instead, the client should query on the Document Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Categories.
For example: publicSectorDocumentCategories?q=AgencyId=<value1>;DocumentCategory=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorDocumentCategories-DocumentSubcategory-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The agency identifier of the public sector entity to which this document subcategory applies. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the document subcategory was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The long description value for the document subcategory related to an attachment. -
DocumentCategory(optional):
string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category. -
DocumentSubcategory(optional):
string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the document subcategory. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the document subcategory was last modified. -
links(optional):
array Items
Title:
Items
Link Relations -
Subcategory(optional):
string
Title:
Subcategory
Maximum Length:25
The value that will be displayed for the document subcategory related to an attachment.
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 : publicSectorDocumentCategories-DocumentSubcategory-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The agency identifier of the public sector entity to which this document subcategory applies. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the document subcategory was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The long description value for the document subcategory related to an attachment. -
DocumentCategory(optional):
string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category. -
DocumentSubcategory(optional):
string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the document subcategory. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the document subcategory was last modified. -
links(optional):
array Items
Title:
Items
Link Relations -
Subcategory(optional):
string
Title:
Subcategory
Maximum Length:25
The value that will be displayed for the document subcategory related to an attachment.
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.