Update a checklist subcategory
patch
/fscmRestApi/resources/11.13.18.05/publicSectorChecklistCategories/{publicSectorChecklistCategoriesUniqID}/child/ChecklistSubcategory/{ChecklistSubcategoryUniqID}
Request
Path Parameters
-
ChecklistSubcategoryUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, CategoryCode and SubcategoryCode ---for the Inspection Checklist Subcategories resource and used to uniquely identify an instance of Inspection Checklist Subcategories. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Subcategories collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Subcategories.
For example: ChecklistSubcategory?q=AgencyId=<value1>;CategoryCode=<value2>;SubcategoryCode=<value3> -
publicSectorChecklistCategoriesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and CategoryCode ---for the Inspection Checklist Categories resource and used to uniquely identify an instance of Inspection Checklist Categories. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Categories collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Categories.
For example: publicSectorChecklistCategories?q=AgencyId=<value1>;CategoryCode=<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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
The description of the checklist subcategory.
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 : publicSectorChecklistCategories-ChecklistSubcategory-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this checklist subcategory applies. -
CategoryCode: string
Title:
Category
Maximum Length:30
The unique code for the inspection checklist category. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the checklist subcategory. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the checklist subcategory was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the checklist subcategory. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the checklist subcategory was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the checklist subcategory. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubcategoryCode: string
Title:
Subcategory
Maximum Length:30
The unique code for the subcategory of an inspection checklist category.
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.