Jump to

• Request
• Response

Create a set of case history records

post

/fscmRestApi/resources/11.13.18.05/publicSectorCaseHistoryRecords

Request

Header Parameters

• Metadata-Context: string
  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: string
  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 name of the attribute that was modified.
• AttributeNewValue: string
  Title: New Value

  Maximum Length: 1000

  The value of the attribute after the modification.
• AttributeOldValue: string
  Title: Old Value

  Maximum Length: 1000

  The value of the attribute before the modification.
• CaseHistoryKey: integer (int64)
  The unique identifier of the case history record.
• CaseHistoryPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case history record.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• ChangeReason: string
  Title: Reason

  Maximum Length: 1000

  The reason for modifying the attribute.
• HistoryTimestamp: string (date-time)
  Title: Date and Time

  The date and time when the case history was recorded.
• HistoryType: string
  Title: Trigger

  Maximum Length: 15

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

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "title":"Updated Attribute",
            "maxLength":30,
            "type":"string",
            "description":"The name of the attribute that was modified.",
            "nullable":false
        },
        "AttributeNewValue":{
            "title":"New Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the attribute after the modification.",
            "nullable":true
        },
        "AttributeOldValue":{
            "title":"Old Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the attribute before the modification.",
            "nullable":true
        },
        "CaseHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of the case history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CaseHistoryPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case history record.",
            "nullable":false
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false
        },
        "ChangeReason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for modifying the attribute.",
            "nullable":true
        },
        "HistoryTimestamp":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the case history was recorded.",
            "format":"date-time",
            "nullable":false
        },
        "HistoryType":{
            "title":"Trigger",
            "maxLength":15,
            "type":"string",
            "description":"The history type of the case history record.",
            "nullable":false
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated source transaction 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 : publicSectorCaseHistoryRecords-item-response

Type: object

Show Source

• AttributeName: string
  Title: Updated Attribute

  Maximum Length: 30

  The name of the attribute that was modified.
• AttributeNewValue: string
  Title: New Value

  Maximum Length: 1000

  The value of the attribute after the modification.
• AttributeOldValue: string
  Title: Old Value

  Maximum Length: 1000

  The value of the attribute before the modification.
• CaseHistoryKey: integer (int64)
  The unique identifier of the case history record.
• CaseHistoryPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case history record.
• CaseKey: integer (int64)
  The unique identifier of the case.
• CasePuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case record.
• ChangeReason: string
  Title: Reason

  Maximum Length: 1000

  The reason for modifying the attribute.
• CreatedBy: string
  Title: Modified 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.
• DerivedNewValue: string
  Read Only: true

  Maximum Length: 255

  The derived value of the attribute after modification.
• DerivedOldValue: string
  Read Only: true

  Maximum Length: 255

  The derived value of the attribute before modification.
• HistoryTimestamp: string (date-time)
  Title: Date and Time

  The date and time when the case history was recorded.
• HistoryType: string
  Title: Trigger

  Maximum Length: 15

  The history type of the case history record.
• 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.
• SourceTransactionKey: integer (int64)
  The unique identifier of the source transaction.
• SourceTransactionPuid: string
  The public unique identifier of the migrated source transaction record.

{
    "type":"object",
    "properties":{
        "AttributeName":{
            "title":"Updated Attribute",
            "maxLength":30,
            "type":"string",
            "description":"The name of the attribute that was modified.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeNewValue":{
            "title":"New Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the attribute after the modification.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeOldValue":{
            "title":"Old Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value of the attribute before the modification.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of the case history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CaseHistoryPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case history record.",
            "nullable":false,
            "x-queryable":true
        },
        "CaseKey":{
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CasePuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case record.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeReason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for modifying the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Modified By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedNewValue":{
            "maxLength":255,
            "type":"string",
            "description":"The derived value of the attribute after modification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedOldValue":{
            "maxLength":255,
            "type":"string",
            "description":"The derived value of the attribute before modification.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoryTimestamp":{
            "title":"Date and Time",
            "type":"string",
            "description":"The date and time when the case history was recorded.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "HistoryType":{
            "title":"Trigger",
            "maxLength":15,
            "type":"string",
            "description":"The history type of the case history record.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the source transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionPuid":{
            "type":"string",
            "description":"The public unique identifier of the migrated source transaction record.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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