Jump to

• Request
• Response

Update a transaction assignee

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTransactionAssignees/{TransAssignKey}

Request

Supported Media Types

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

Path Parameters

• TransAssignKey: integer
  Indicates the transaction key for the assignment record.

Body ()

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

Root Schema : publicSectorTransactionAssignees-item

Type: object

Show Source

• Active(optional): string
  Title: Active

  Maximum Length: 1

  Indicates the currently active assignee for the transaction. The default value is yes.
• AssignedDatetime(optional): string(date-time)
  Title: Assigned Date and Time

  The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.
• AssigneeId(optional): integer(int64)
  Title: Assignee ID

  The unique ID of the agency staff assigned to the transaction.
• AssigneeJob(optional): string
  The job of the agency staff assigned to the transaction.
• AssigneeName(optional): string
  The name of the agency staff assigned to the transaction.
• AssigneeType(optional): string
  Title: Assignee Type

  Maximum Length: 20

  The role of the agency staff assigned to the transaction.
• AssigneeUserid(optional): string
  Title: Assignee User ID

  Maximum Length: 64

  The unique user ID of the agency staff assigned to the transaction.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the assessment details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the assessment details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the assessment details were last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The license and permit record, for example a license number with a value such as RA-2017-00029.
• LnpRecordKey(optional): integer(int64)
  Title: Transaction Key

  Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The description of the role of the agency staff assigned to the transaction.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  The user who last updated the assessment details.
• ParentPuid(optional): string
  Maximum Length: 64

  The public unique identifier of a migrated record.
• TransAssignKey(optional): integer(int64)
  Indicates the transaction key for the assignment record.
• TransAssignPuid(optional): string
  Maximum Length: 480

  The public unique identifier of a migrated transaction assignment record.

{
    "properties":{
        "Active":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the currently active assignee for the transaction. The default value is yes.",
            "title":"Active"
        },
        "AssignedDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.",
            "title":"Assigned Date and Time"
        },
        "AssigneeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique ID of the agency staff assigned to the transaction.",
            "title":"Assignee ID"
        },
        "AssigneeJob":{
            "type":"string",
            "description":"The job of the agency staff assigned to the transaction."
        },
        "AssigneeName":{
            "type":"string",
            "description":"The name of the agency staff assigned to the transaction."
        },
        "AssigneeType":{
            "maxLength":20,
            "type":"string",
            "description":"The role of the agency staff assigned to the transaction.",
            "title":"Assignee Type"
        },
        "AssigneeUserid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique user ID of the agency staff assigned to the transaction.",
            "title":"Assignee User ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the assessment details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "title":"Last Updated Date"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The license and permit record, for example a license number with a value such as RA-2017-00029.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "title":"Transaction Key"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the role of the agency staff assigned to the transaction.",
            "title":"Meaning"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The user who last updated the assessment details.",
            "title":"Object Version Number"
        },
        "ParentPuid":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of a migrated record."
        },
        "TransAssignKey":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the transaction key for the assignment record."
        },
        "TransAssignPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of a migrated transaction assignment record."
        },
        "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 : publicSectorTransactionAssignees-item

Type: object

Show Source

• Active(optional): string
  Title: Active

  Maximum Length: 1

  Indicates the currently active assignee for the transaction. The default value is yes.
• AssignedDatetime(optional): string(date-time)
  Title: Assigned Date and Time

  The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.
• AssigneeId(optional): integer(int64)
  Title: Assignee ID

  The unique ID of the agency staff assigned to the transaction.
• AssigneeJob(optional): string
  The job of the agency staff assigned to the transaction.
• AssigneeName(optional): string
  The name of the agency staff assigned to the transaction.
• AssigneeType(optional): string
  Title: Assignee Type

  Maximum Length: 20

  The role of the agency staff assigned to the transaction.
• AssigneeUserid(optional): string
  Title: Assignee User ID

  Maximum Length: 64

  The unique user ID of the agency staff assigned to the transaction.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the assessment details.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the assessment details were created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the assessment details were last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Record ID

  Maximum Length: 50

  The license and permit record, for example a license number with a value such as RA-2017-00029.
• LnpRecordKey(optional): integer(int64)
  Title: Transaction Key

  Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The description of the role of the agency staff assigned to the transaction.
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  The user who last updated the assessment details.
• ParentPuid(optional): string
  Maximum Length: 64

  The public unique identifier of a migrated record.
• TransAssignKey(optional): integer(int64)
  Indicates the transaction key for the assignment record.
• TransAssignPuid(optional): string
  Maximum Length: 480

  The public unique identifier of a migrated transaction assignment record.

{
    "properties":{
        "Active":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates the currently active assignee for the transaction. The default value is yes.",
            "title":"Active"
        },
        "AssignedDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the assignment of agency staff to a transaction was made. This allows for history tracking and multiple assignments.",
            "title":"Assigned Date and Time"
        },
        "AssigneeId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique ID of the agency staff assigned to the transaction.",
            "title":"Assignee ID"
        },
        "AssigneeJob":{
            "type":"string",
            "description":"The job of the agency staff assigned to the transaction."
        },
        "AssigneeName":{
            "type":"string",
            "description":"The name of the agency staff assigned to the transaction."
        },
        "AssigneeType":{
            "maxLength":20,
            "type":"string",
            "description":"The role of the agency staff assigned to the transaction.",
            "title":"Assignee Type"
        },
        "AssigneeUserid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique user ID of the agency staff assigned to the transaction.",
            "title":"Assignee User ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the assessment details.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "title":"Last Updated Date"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The license and permit record, for example a license number with a value such as RA-2017-00029.",
            "title":"Record ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the transaction key for the main record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "title":"Transaction Key"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the role of the agency staff assigned to the transaction.",
            "title":"Meaning"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The user who last updated the assessment details.",
            "title":"Object Version Number"
        },
        "ParentPuid":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of a migrated record."
        },
        "TransAssignKey":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the transaction key for the assignment record."
        },
        "TransAssignPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of a migrated transaction assignment record."
        },
        "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