Jump to

• Request
• Response

Get a transaction assignee

get

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

Request

Path Parameters

• TransAssignKey(required): integer(int64)
  Indicates the transaction key for the assignment record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• Active: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates the currently active assignee for the transaction. The default value is yes.
• AssignedDatetime: 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.
• AssigneeEmail: string
  Read Only: true

  The official email ID of the planner or specialist assigned to the transaction.
• AssigneeId: integer (int64)
  Title: Assignee ID

  The unique ID of the agency staff assigned to the transaction.
• AssigneeJob: string
  Read Only: true

  The job of the agency staff assigned to the transaction.
• AssigneeName: string
  Read Only: true

  Maximum Length: 240

  The name of the agency staff assigned to the transaction.
• AssigneeType: string
  Title: Assignee Type

  Maximum Length: 20

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

  Maximum Length: 64

  The unique user ID of the agency staff assigned to the transaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Read Only: true

  The date when the assessment details were last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: 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: 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: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  The description of the role of the agency staff assigned to the transaction.
• NextAssignee: string
  Read Only: true

  The assignee to whom the transaction was assigned next.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

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

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

  The public unique identifier of a migrated transaction assignment record.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the agency staff assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the assessment details were created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Record ID",
            "maxLength":"50",
            "type":"string",
            "description":"The license and permit record, for example a license number with a value such as RA-2017-00029.",
            "nullable":false,
            "x-queryable":true
        },
        "AssigneeUserid":{
            "title":"Assignee User ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique user ID of the agency staff assigned to the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeEmail":{
            "type":"string",
            "description":"The official email ID of the planner or specialist assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LnpRecordKey":{
            "title":"Transaction Key",
            "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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated record.",
            "nullable":false,
            "x-queryable":true
        },
        "Active":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the currently active assignee for the transaction. The default value is yes.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "AssigneeJob":{
            "type":"string",
            "description":"The job of the agency staff assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AssigneeId":{
            "title":"Assignee ID",
            "type":"integer",
            "description":"The unique ID of the agency staff assigned to the transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssigneeType":{
            "title":"Assignee Type",
            "maxLength":"20",
            "type":"string",
            "description":"The role of the agency staff assigned to the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The user who last updated the assessment details.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TransAssignKey":{
            "type":"integer",
            "description":"Indicates the transaction key for the assignment record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignedDatetime":{
            "title":"Assigned Date and 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.",
            "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"
            }
        },
        "NextAssignee":{
            "type":"string",
            "description":"The assignee to whom the transaction was assigned next.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The description of the role of the agency staff assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransAssignPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of a migrated transaction assignment record.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the assessment details were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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