Update a violation code reference
patch
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}
Request
Path Parameters
-
publicSectorViolationCodeReferencesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and CodeReferenceCode ---for the Violation Code References resource and used to uniquely identify an instance of Violation Code References. The client should not generate the hash key value. Instead, the client should query on the Violation Code References collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Code References.
For example: publicSectorViolationCodeReferences?q=AgencyId=<value1>;CodeReferenceCode=<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
-
CorrectiveActionCode: string
Title:
Corrective Action
Maximum Length:100
The corrective action code of the record. -
Description: string
(byte)
Title:
Description
The description of the violation code reference. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation code reference is available for use. -
Name: string
Title:
Summary
Maximum Length:200
The name of the violation code reference.
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 : publicSectorViolationCodeReferences-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier of the agency. -
CodeReferenceCode: string
Title:
Code Reference ID
Maximum Length:100
The violation code reference code of the record. -
CorrectiveActionCode: string
Title:
Corrective Action
Maximum Length:100
The corrective action code of the record. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
Description: string
(byte)
Title:
Description
The description of the violation code reference. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether the violation code reference is available for use. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Summary
Maximum Length:200
The name of the violation code reference.
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.