Jump to

• Request
• Response

Update a status history event record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{publicSectorStatusHistoriesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorStatusHistoriesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- TransactionType, TransactionKey and ChangeDate ---for the Status Histories resource and used to uniquely identify an instance of Status Histories. The client should not generate the hash key value. Instead, the client should query on the Status Histories collection resource with a filter on the primary key values in order to navigate to a specific instance of Status Histories.
  
  For example: publicSectorStatusHistories?q=TransactionType=<value1>;TransactionKey=<value2>;ChangeDate=<value3>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorStatusHistories-item

Type: object

Show Source

• AttributeChanged(optional): string
  Title: Attribute Changed

  Maximum Length: 30

  The column name or attribute that was changed.
• ChangeDate(optional): string(date-time)
  Title: Updated Date

  The date when the status change was made.
• CreatedBy(optional): string
  Title: Updated By

  Maximum Length: 64

  The user who changed the status.
• CreatedByName(optional): string
  The user who changed the status.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the status was changed.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the status change was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who made the last status change.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Permit

  Maximum Length: 50

  The permit transaction identification number.
• LnpRecordKey(optional): integer(int64)
  The unique identifier for the related permit transaction.
• NewValue(optional): string
  Title: Status

  Maximum Length: 100

  The new value for the column or attribute that was changed.
• Reason(optional): string
  Title: Reason

  Maximum Length: 1000

  The reason for the status change.
• RecordTypeCode(optional): string
  Title: Permit Type Code

  Maximum Length: 20

  The unique identifier for the permit type code.
• RelAttributeChanged(optional): string
  Title: Related Attribute Changed

  Maximum Length: 30

  The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the permit transaction, for example, the main attribute is Permit Status and a secondary or related attribute is System Status.
• RelNewValue(optional): string
  Title: Related Value

  Maximum Length: 100

  The new value for the related attribute that was changed. The related attribute value is a secondary attribute value for a given transaction. For the permit transaction, for example, the secondary or related attribute is System Status and the related attribute value could be PND or Pending.
• TransactionId(optional): string
  Title: Transaction ID

  Maximum Length: 100

  The transaction identification number.
• TransactionKey(optional): string
  Title: Transaction Key

  Maximum Length: 100

  The unique identifier for the subject code transaction.
• TransactionType(optional): string
  Title: Transaction Type

  Maximum Length: 10

  The transaction type relating to the status change. For example, plan review, inspection, or hearing.

{
    "properties":{
        "AttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The column name or attribute that was changed.",
            "title":"Attribute Changed"
        },
        "ChangeDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status change was made.",
            "title":"Updated Date"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who changed the status.",
            "title":"Updated By"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The user who changed the status."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status was changed.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status change was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who made the last status change.",
            "title":"Last Updated By"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The permit transaction identification number.",
            "title":"Permit"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related permit transaction."
        },
        "NewValue":{
            "maxLength":100,
            "type":"string",
            "description":"The new value for the column or attribute that was changed.",
            "title":"Status"
        },
        "Reason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the status change.",
            "title":"Reason"
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the permit type code.",
            "title":"Permit Type Code"
        },
        "RelAttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the permit transaction, for example, the main attribute is Permit Status and a secondary or related attribute is System Status.",
            "title":"Related Attribute Changed"
        },
        "RelNewValue":{
            "maxLength":100,
            "type":"string",
            "description":"The new value for the related attribute that was changed. The related attribute value is a secondary attribute value for a given transaction. For the permit transaction, for example, the secondary or related attribute is System Status and the related attribute value could be PND or Pending.",
            "title":"Related Value"
        },
        "TransactionId":{
            "maxLength":100,
            "type":"string",
            "description":"The transaction identification number.",
            "title":"Transaction ID"
        },
        "TransactionKey":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the subject code transaction.",
            "title":"Transaction Key"
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The transaction type relating to the status change. For example, plan review, inspection, or hearing.",
            "title":"Transaction Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorStatusHistories-item

Type: object

Show Source

• AttributeChanged(optional): string
  Title: Attribute Changed

  Maximum Length: 30

  The column name or attribute that was changed.
• ChangeDate(optional): string(date-time)
  Title: Updated Date

  The date when the status change was made.
• CreatedBy(optional): string
  Title: Updated By

  Maximum Length: 64

  The user who changed the status.
• CreatedByName(optional): string
  The user who changed the status.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the status was changed.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the status change was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who made the last status change.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Permit

  Maximum Length: 50

  The permit transaction identification number.
• LnpRecordKey(optional): integer(int64)
  The unique identifier for the related permit transaction.
• NewValue(optional): string
  Title: Status

  Maximum Length: 100

  The new value for the column or attribute that was changed.
• Reason(optional): string
  Title: Reason

  Maximum Length: 1000

  The reason for the status change.
• RecordTypeCode(optional): string
  Title: Permit Type Code

  Maximum Length: 20

  The unique identifier for the permit type code.
• RelAttributeChanged(optional): string
  Title: Related Attribute Changed

  Maximum Length: 30

  The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the permit transaction, for example, the main attribute is Permit Status and a secondary or related attribute is System Status.
• RelNewValue(optional): string
  Title: Related Value

  Maximum Length: 100

  The new value for the related attribute that was changed. The related attribute value is a secondary attribute value for a given transaction. For the permit transaction, for example, the secondary or related attribute is System Status and the related attribute value could be PND or Pending.
• TransactionId(optional): string
  Title: Transaction ID

  Maximum Length: 100

  The transaction identification number.
• TransactionKey(optional): string
  Title: Transaction Key

  Maximum Length: 100

  The unique identifier for the subject code transaction.
• TransactionType(optional): string
  Title: Transaction Type

  Maximum Length: 10

  The transaction type relating to the status change. For example, plan review, inspection, or hearing.

{
    "properties":{
        "AttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The column name or attribute that was changed.",
            "title":"Attribute Changed"
        },
        "ChangeDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status change was made.",
            "title":"Updated Date"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who changed the status.",
            "title":"Updated By"
        },
        "CreatedByName":{
            "type":"string",
            "description":"The user who changed the status."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status was changed.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the status change was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who made the last status change.",
            "title":"Last Updated By"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The permit transaction identification number.",
            "title":"Permit"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related permit transaction."
        },
        "NewValue":{
            "maxLength":100,
            "type":"string",
            "description":"The new value for the column or attribute that was changed.",
            "title":"Status"
        },
        "Reason":{
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the status change.",
            "title":"Reason"
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the permit type code.",
            "title":"Permit Type Code"
        },
        "RelAttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The related column attribute that was changed. The related attribute is a secondary attribute for a given transaction. For the permit transaction, for example, the main attribute is Permit Status and a secondary or related attribute is System Status.",
            "title":"Related Attribute Changed"
        },
        "RelNewValue":{
            "maxLength":100,
            "type":"string",
            "description":"The new value for the related attribute that was changed. The related attribute value is a secondary attribute value for a given transaction. For the permit transaction, for example, the secondary or related attribute is System Status and the related attribute value could be PND or Pending.",
            "title":"Related Value"
        },
        "TransactionId":{
            "maxLength":100,
            "type":"string",
            "description":"The transaction identification number.",
            "title":"Transaction ID"
        },
        "TransactionKey":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the subject code transaction.",
            "title":"Transaction Key"
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The transaction type relating to the status change. For example, plan review, inspection, or hearing.",
            "title":"Transaction Type"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top