Jump to

• Request
• Response

Create a case code violation history record

post

/fscmRestApi/resources/11.13.18.05/publicSectorCodeReferenceHistoryRecords

Request

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

• AttributeName: string
  Title: Updated Attribute

  Maximum Length: 30

  The attribute name of the case code violation history record.
• AttributeNewValue: string
  Title: New Value

  Maximum Length: 1000

  The new value of the case code violation history attribute.
• AttributeOldValue: string
  Title: Old Value

  Maximum Length: 1000

  The old value of the case code violation history attribute.
• ChangeReasonCode: string
  Title: Reason for Update

  Maximum Length: 30

  Default Value: ORA_ADMIN

  The change reason identifier of the case code violation history record.
• ChangeReasonText: string
  Title: Reason Details

  Maximum Length: 1000

  The change reason description of the case code violation history record.
• CodeReferenceHistoryKey: integer (int64)
  The unique identifier of the case code violation history record.
• CodeReferenceHistoryPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code violation history record.
• CodeReferenceKey: integer (int64)
  The unique identifier of the case code violation record.
• CodeReferencePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code violation record.
• HistoryTimestamp: string (date-time)
  Title: Date and Time

  The date and time when the code violation history row was created.
• HistoryType: string
  Title: Source

  Maximum Length: 15

  The type of the code violation history record.
• SourceTransactionKey: integer (int64)
  The unique identifier of the source transaction that created the code violation history record.
• SourceTransactionPuid: string
  The public unique identifier of the migrated source transaction record.

{
    "type":"object",
    "properties":{
        "AttributeOldValue":{
            "title":"Old Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The old value of the case code violation history attribute.",
            "nullable":true
        },
        "CodeReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case code violation record.",
            "nullable":false
        },
        "HistoryType":{
            "title":"Source",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the code violation history record.",
            "nullable":false
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated source transaction record.",
            "nullable":true
        },
        "AttributeNewValue":{
            "title":"New Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The new value of the case code violation history attribute.",
            "nullable":true
        },
        "CodeReferenceHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of the case code violation history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "maxLength":"30",
            "type":"string",
            "description":"The change reason identifier of the case code violation history record.",
            "nullable":false,
            "default":"ORA_ADMIN"
        },
        "HistoryTimestamp":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the code violation history row was created.",
            "format":"date-time",
            "nullable":false
        },
        "AttributeName":{
            "title":"Updated Attribute",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute name of the case code violation history record.",
            "nullable":false
        },
        "CodeReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the case code violation record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source transaction that created the code violation history record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CodeReferenceHistoryPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case code violation history record.",
            "nullable":false
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "maxLength":"1000",
            "type":"string",
            "description":"The change reason description of the case code violation history record.",
            "nullable":true
        }
    }
}

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 : publicSectorCodeReferenceHistoryRecords-item-response

Type: object

Show Source

• AttributeName: string
  Title: Updated Attribute

  Maximum Length: 30

  The attribute name of the case code violation history record.
• AttributeNewValue: string
  Title: New Value

  Maximum Length: 1000

  The new value of the case code violation history attribute.
• AttributeOldValue: string
  Title: Old Value

  Maximum Length: 1000

  The old value of the case code violation history attribute.
• CaseKey: string
  Read Only: true

  Maximum Length: 255

  The unique identifier of the case.
• ChangeReasonCode: string
  Title: Reason for Update

  Maximum Length: 30

  Default Value: ORA_ADMIN

  The change reason identifier of the case code violation history record.
• ChangeReasonText: string
  Title: Reason Details

  Maximum Length: 1000

  The change reason description of the case code violation history record.
• CodeReferenceCode: string
  Read Only: true

  Maximum Length: 255

  The unique identifier of the case code violation record.
• CodeReferenceHistoryKey: integer (int64)
  The unique identifier of the case code violation history record.
• CodeReferenceHistoryPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code violation history record.
• CodeReferenceKey: integer (int64)
  The unique identifier of the case code violation record.
• CodeReferencePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case code violation record.
• CreatedByName: string
  Read Only: true

  Maximum Length: 255

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Created On

  Read Only: true

  The date and time when the row was created.
• DerivedNewValue: string
  Read Only: true

  Maximum Length: 255

  The new value of the case code violation history derived attribute.
• DerivedOldValue: string
  Read Only: true

  Maximum Length: 255

  The old value of the case code violation history derived attribute.
• HistoryTimestamp: string (date-time)
  Title: Date and Time

  The date and time when the code violation history row was created.
• HistoryType: string
  Title: Source

  Maximum Length: 15

  The type of the code violation history record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceTransactionKey: integer (int64)
  The unique identifier of the source transaction that created the code violation history record.
• SourceTransactionPuid: string
  The public unique identifier of the migrated source transaction record.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Created On",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseKey":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeReferenceCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of the case code violation record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedNewValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The new value of the case code violation history derived attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeOldValue":{
            "title":"Old Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The old value of the case code violation history attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CodeReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case code violation record.",
            "nullable":false,
            "x-queryable":true
        },
        "HistoryType":{
            "title":"Source",
            "maxLength":"15",
            "type":"string",
            "description":"The type of the code violation history record.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated source transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNewValue":{
            "title":"New Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The new value of the case code violation history attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DerivedOldValue":{
            "maxLength":"255",
            "type":"string",
            "description":"The old value of the case code violation history derived attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodeReferenceHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of the case code violation history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "title":"Reason for Update",
            "maxLength":"30",
            "type":"string",
            "description":"The change reason identifier of the case code violation history record.",
            "nullable":false,
            "default":"ORA_ADMIN",
            "x-queryable":true
        },
        "HistoryTimestamp":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the code violation history row was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Updated Attribute",
            "maxLength":"30",
            "type":"string",
            "description":"The attribute name of the case code violation history record.",
            "nullable":false,
            "x-queryable":true
        },
        "CodeReferenceKey":{
            "type":"integer",
            "description":"The unique identifier of the case code violation record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source transaction that created the code violation history record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CodeReferenceHistoryPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the migrated case code violation history record.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeReasonText":{
            "title":"Reason Details",
            "maxLength":"1000",
            "type":"string",
            "description":"The change reason description of the case code violation history record.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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