Update a code violation
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCases/{CaseKey}/child/CaseCodeReference/{publicSectorCases_CaseCodeReference_Id}
Request
Path Parameters
-
CaseKey(required): integer(int64)
The unique identifier of the case.
-
publicSectorCases_CaseCodeReference_Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
ChangeReasonCode: string
Title:
Reason for Update
Default Value:ORA_ADMIN
-
ChangeReasonText: string
Title:
Description
-
CodeReferenceDescription: string
(byte)
-
CodeReferenceName: string
Maximum Length:
200
-
Comments: string
Title:
Comments
Maximum Length:1000
-
CompliedOn: string
(date)
Title:
Complied On
-
ComplyBy: string
(date)
Title:
Comply By
-
CorrectiveActionDescription: string
(byte)
-
FeeFrequencyUnit: string
Title:
Frequency
Maximum Length:30
Default Value:ORA_F
-
FeeRate: number
Title:
Rate
Default Value:0
-
SourceTransactionContext: string
Maximum Length:
80
Default Value:ORA_MAN
-
SourceTransactionContextKey: integer
-
Status: string
Title:
Status
Maximum Length:8
Default Value:ORA_OPEN
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 : publicSectorCases-CaseCodeReference-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
-
CaseId: string
Read Only:
true
Maximum Length:50
-
CaseKey: integer
(int64)
-
CasePuid: string
Maximum Length:
480
Default Value: -
ChangeReasonCode: string
Title:
Reason for Update
Default Value:ORA_ADMIN
-
ChangeReasonText: string
Title:
Description
-
CodeReferenceCode: string
Title:
Code Violation
Maximum Length:100
-
CodeReferenceDescription: string
(byte)
-
CodeReferenceKey: integer
(int64)
-
CodeReferenceName: string
Maximum Length:
200
-
CodeReferencePuid: string
Maximum Length:
480
-
Comments: string
Title:
Comments
Maximum Length:1000
-
CompliedOn: string
(date)
Title:
Complied On
-
ComplyBy: string
(date)
Title:
Comply By
-
CorrectiveActionCode: string
Maximum Length:
100
-
CorrectiveActionDescription: string
(byte)
-
CorrectiveActionName: string
Maximum Length:
200
-
CreationDate: string
(date-time)
Read Only:
true
-
FeeFrequencyUnit: string
Title:
Frequency
Maximum Length:30
Default Value:ORA_F
-
FeeRate: number
Title:
Rate
Default Value:0
-
LastUpdateDate: string
(date-time)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SourceInspectionKey: integer
(int64)
-
SourceInspectionPuid: string
Maximum Length:
480
-
SourceTransactionContext: string
Maximum Length:
80
Default Value:ORA_MAN
-
SourceTransactionContextKey: integer
-
Status: string
Title:
Status
Maximum Length:8
Default Value:ORA_OPEN
-
StatusText: string
Read Only:
true
Maximum Length:255
-
TotalFees: number
Title:
Total Fine
Read Only:true
-
TotalPaidFees: number
Title:
Total Fine Paid
Read Only:true
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.