Update an inspection status
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionStatuses/{publicSectorInspectionStatusesUniqID}
Request
Path Parameters
-
publicSectorInspectionStatusesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and SystemStatus ---for the Inspection Statuses resource and used to uniquely identify an instance of Inspection Statuses. The client should not generate the hash key value. Instead, the client should query on the Inspection Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Statuses.
For example: publicSectorInspectionStatuses?q=AgencyId=<value1>;SystemStatus=<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
-
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the inspection status. -
InspectionStatus: string
Title:
Status
Maximum Length:15
The name of the inspection status. The status name is used as the display status for the inspection in the permit application. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
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 : publicSectorInspectionStatuses-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
The identifier for the public sector agency to which this inspection status applies. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the inspection status was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the inspection status. -
InspectionStatus: string
Title:
Status
Maximum Length:15
The name of the inspection status. The status name is used as the display status for the inspection in the permit application. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the inspection status was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated. -
SystemStatus: string
Title:
System Status
Maximum Length:15
The unique identifier for the inspection status.
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.