Update a record type inspection option
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypeInspectionOptions/{publicSectorRecordTypeInspectionOptionsUniqID}
Request
Path Parameters
-
publicSectorRecordTypeInspectionOptionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, RecordTypeId, VersionType and InspectionType ---for the Record Type Inspection Options resource and used to uniquely identify an instance of Record Type Inspection Options. The client should not generate the hash key value. Instead, the client should query on the Record Type Inspection Options collection resource with a filter on the primary key values in order to navigate to a specific instance of Record Type Inspection Options.
For example: publicSectorRecordTypeInspectionOptions?q=AgencyId=<value1>;RecordTypeId=<value2>;VersionType=<value3>;InspectionType=<value4>
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
-
AgencyId: integer
(int32)
The agency identifier of the public sector entity for which options are set.
-
AutoPendingInspections: boolean
Maximum Length:
1
Indicates whether pending inspections will be automatically created for the specified record type and inspection type. -
InspectionType: string
Maximum Length:
15
The inspection type for which options are set. -
RecordTypeId: string
Maximum Length:
30
The record type for which options are set.
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 : publicSectorRecordTypeInspectionOptions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The agency identifier of the public sector entity for which options are set.
-
AutoPendingInspections: boolean
Maximum Length:
1
Indicates whether pending inspections will be automatically created for the specified record type and inspection type. -
InspectionType: string
Maximum Length:
15
The inspection type for which options are set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordTypeId: string
Maximum Length:
30
The record type for which options are set. -
VersionType: string
Maximum Length:
1
Default Value:O
The activity for which options are set, such as origination, amendment, or renewal.
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.