Jump to

• Request
• Response

Update a status history event record

patch

/fscmRestApi/resources/11.13.18.05/publicSectorStatusHistories/{StatusHistoryKey}

Request

Path Parameters

• StatusHistoryKey(required): integer(int64)
  The unique identifier of status history.

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

• AttributeChanged: string
  Title: Attribute Changed

  Maximum Length: 30

  The column name or attribute that was changed.
• EventCode: string
  Maximum Length: 30

  An identifier to track the system events that may not result in a status change.
• LnpRecordId: string
  Title: Permit

  Maximum Length: 50

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

  Maximum Length: 100

  The new value for the column or attribute that was changed.
• OriginalCreatedBy: string
  Indicates the user who created the migrated data from source system.
• Reason: string
  Title: Reason

  Maximum Length: 1000

  The reason for the status change.
• RecordNumber: string
  Maximum Length: 64

  Indicates the parent public unique identifier of status history used for import activity.
• RecordTypeCode: string
  Title: Permit Type Code

  Maximum Length: 20

  The unique identifier for the permit type code.
• RelAttributeChanged: 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: 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.
• StatusHistoryPuid: string
  Maximum Length: 480

  Indicates the public unique identifier of the status history used for import activity.
• TransactionId: string
  Title: Transaction ID

  Maximum Length: 100

  The transaction identification number.

{
    "type":"object",
    "properties":{
        "AttributeChanged":{
            "title":"Attribute Changed",
            "maxLength":30,
            "type":"string",
            "description":"The column name or attribute that was changed.",
            "nullable":true
        },
        "EventCode":{
            "maxLength":30,
            "type":"string",
            "description":"An identifier to track the system events that may not result in a status change.",
            "nullable":true
        },
        "LnpRecordId":{
            "title":"Permit",
            "maxLength":50,
            "type":"string",
            "description":"The permit transaction identification number.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the related permit transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NewValue":{
            "title":"Status",
            "maxLength":100,
            "type":"string",
            "description":"The new value for the column or attribute that was changed.",
            "nullable":true
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the migrated data from source system.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Reason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the status change.",
            "nullable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the parent public unique identifier of status history used for import activity.",
            "nullable":true
        },
        "RecordTypeCode":{
            "title":"Permit Type Code",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the permit type code.",
            "nullable":true
        },
        "RelAttributeChanged":{
            "title":"Related Attribute Changed",
            "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.",
            "nullable":true
        },
        "RelNewValue":{
            "title":"Related Value",
            "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.",
            "nullable":true
        },
        "StatusHistoryPuid":{
            "maxLength":480,
            "type":"string",
            "description":"Indicates the public unique identifier of the status history used for import activity.",
            "nullable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "maxLength":100,
            "type":"string",
            "description":"The transaction identification number.",
            "nullable":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 : publicSectorStatusHistories-item-response

Type: object

Show Source

• AttributeChanged: string
  Title: Attribute Changed

  Maximum Length: 30

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

  The date when the status change was made.
• CreatedByName: string
  Read Only: true

  The user who changed the status.
• EventCode: string
  Maximum Length: 30

  An identifier to track the system events that may not result in a status change.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Permit

  Maximum Length: 50

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

  Maximum Length: 100

  The new value for the column or attribute that was changed.
• OriginalCreatedBy: string
  Indicates the user who created the migrated data from source system.
• Reason: string
  Title: Reason

  Maximum Length: 1000

  The reason for the status change.
• RecordNumber: string
  Maximum Length: 64

  Indicates the parent public unique identifier of status history used for import activity.
• RecordTypeCode: string
  Title: Permit Type Code

  Maximum Length: 20

  The unique identifier for the permit type code.
• RelAttributeChanged: 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: 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.
• StatusHistoryKey: integer (int64)
  The unique identifier of status history.
• StatusHistoryPuid: string
  Maximum Length: 480

  Indicates the public unique identifier of the status history used for import activity.
• TransactionId: string
  Title: Transaction ID

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 10

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

{
    "type":"object",
    "properties":{
        "AttributeChanged":{
            "title":"Attribute Changed",
            "maxLength":30,
            "type":"string",
            "description":"The column name or attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeDate":{
            "title":"Updated Date",
            "type":"string",
            "description":"The date when the status change was made.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedByName":{
            "type":"string",
            "description":"The user who changed the status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "maxLength":30,
            "type":"string",
            "description":"An identifier to track the system events that may not result in a status change.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Permit",
            "maxLength":50,
            "type":"string",
            "description":"The permit transaction identification number.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the related permit transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NewValue":{
            "title":"Status",
            "maxLength":100,
            "type":"string",
            "description":"The new value for the column or attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"Indicates the user who created the migrated data from source system.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Reason":{
            "title":"Reason",
            "maxLength":1000,
            "type":"string",
            "description":"The reason for the status change.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the parent public unique identifier of status history used for import activity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Permit Type Code",
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier for the permit type code.",
            "nullable":true,
            "x-queryable":true
        },
        "RelAttributeChanged":{
            "title":"Related Attribute Changed",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "RelNewValue":{
            "title":"Related Value",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusHistoryKey":{
            "type":"integer",
            "description":"The unique identifier of status history.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StatusHistoryPuid":{
            "maxLength":480,
            "type":"string",
            "description":"Indicates the public unique identifier of the status history used for import activity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "maxLength":100,
            "type":"string",
            "description":"The transaction identification number.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionKey":{
            "title":"Transaction Key",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier for the subject code transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":10,
            "type":"string",
            "description":"The transaction type relating to the status change. For example, plan review, inspection, or hearing.",
            "nullable":false,
            "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