Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChangeReasonCode: string
  Title: Reason for Update

  Default Value: ORA_ADMIN
• ChangeReasonText: string
  Title: Reason Details
• 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

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"8",
            "type":"string",
            "nullable":false,
            "default":"ORA_OPEN"
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "default":"0"
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "nullable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_F"
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "type":"string",
            "nullable":true,
            "default":"ORA_ADMIN",
            "x-queryable":false
        },
        "CodeReferenceDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionContext":{
            "maxLength":"80",
            "type":"string",
            "nullable":true,
            "default":"ORA_MAN",
            "x-queryable":false
        },
        "CodeReferenceName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "type":"string",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorCases-CaseCodeReference-item-response

Type: object

Show Source

• 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: Reason Details
• 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

{
    "type":"object",
    "properties":{
        "SourceInspectionPuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "StatusText":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CompliedOn":{
            "title":"Complied On",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":"480",
            "type":"string",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CodeReferenceName":{
            "maxLength":"200",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TotalPaidFees":{
            "title":"Total Fine Paid",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"8",
            "type":"string",
            "nullable":false,
            "default":"ORA_OPEN",
            "x-queryable":true
        },
        "SourceTransactionContextKey":{
            "type":"integer",
            "nullable":true,
            "x-queryable":false
        },
        "CaseKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CodeReferenceCode":{
            "title":"Code Violation",
            "maxLength":"100",
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "FeeRate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "maxLength":"50",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ComplyBy":{
            "title":"Comply By",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FeeFrequencyUnit":{
            "title":"Frequency",
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "default":"ORA_F",
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fine",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectiveActionCode":{
            "maxLength":"100",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceInspectionKey":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "type":"string",
            "nullable":true,
            "default":"ORA_ADMIN",
            "x-queryable":false
        },
        "CodeReferenceDescription":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceTransactionContext":{
            "maxLength":"80",
            "type":"string",
            "nullable":true,
            "default":"ORA_MAN",
            "x-queryable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "type":"string",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top