Jump to

• Request
• Response

Get all related transactions

get

/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactionQueries

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the related transaction that matches the primary key criteria.
    Finder Variables:
    • AddedDate; string; The unique identifier of the related transaction.
    • RelTransKey; number; The unique identifier of the related transaction.
    • TransactionKey; integer; The unique identifier of the related transaction.
  • RelatedTransactions: Finds all the related transactions that matches the record identifier.
    Finder Variables:
    • RecordKey; integer; The unique identifier of the related transaction.
    • hideIndirect; string; A flag to show indirect transaction links.
    • typeFilter; string; A flag to show primary, sub-application, and linked transactions.
  • SimpleSearchOtherFinder: Finds all the related transactions that matches the record identifier.
    Finder Variables:
    • RecordKey; integer; The unique identifier of the related transaction.
    • hideIndirect; string; A flag to show indirect transaction links.
    • typeFilter; string; A flag to show primary, sub-application, and linked transactions.
    • value; string; A parameter for searching the related transactions.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AddedDate; string; The unique identifier of the pre-application or business license consultation.
  • AssignedUserName; string; The user name of the assigned user for the related planning application.
  • Classification; string; The classification of the related application like permit, planning application, or business license.
  • ClassificationDescription; string; A description of the classification code of the current transaction.
  • CoaCount; number; Indicates the total number of conditions of approval applied on the related transaction.
  • DeleteFlag; string; Indicates whether the user has access to remove the related transaction row.
  • Dependency; string; The dependency between related applications like ORA_PREAPP, ORA_REQ, or ORA_REL.
  • Description; string; The comments added for the related transaction.
  • LastUpdateDate; string; The date and time when the related application was last updated.
  • LinkedByName; string; The user who linked the transaction to current application.
  • ManualLinkFlag; string; The related transaction link is for neither the primary nor subapplication of the current application.
  • OrderDate; string; The transaction change date of the parent transaction.
  • OrderKey; integer; The parent transaction key for the current transaction.
  • ParPriFlag; string; The current application is the primary application for the related transaction.
  • ParSubFlag; string; The current application is the sub-application for the related transaction.
  • PriAppFlag; string; The related transaction is the primary application of the current application.
  • PrimaryLinkFlag; string; The related transaction link is for the primary application of the current application.
  • RecordType; string; The application type of the related application.
  • RelTransId; string; The application identifier of the related application.
  • RelTransKey; number; The application key of the related application.
  • RelTransTypeCode; string; The application type code for the related application.
  • RelTransTypeId; string; The application type identifier for the related application.
  • RelTransactionType; string; Identifies the related transaction type like permit, planning application, business license, or case.
  • RelatedKey; number; The unique identifier of the related record transaction.
  • ReltransCoaAppl; number; Indicates total number conditions of approval applied on the current permit application from it's related planning application.
  • Status; string; The status of the related application.
  • SubAppFlag; string; The related transaction is the sub-application of the current application.
  • SubLinkFlag; string; The related transaction link is for the subapplication of the current application.
  • SystemStatus; string; The system status of the related application.
  • TransCoaAppl; number; Indicates the total number of conditions of approval applied on related permit application from current planning application.
  • TransactionId; string; The permit, planning application, or business license identifier.
  • TransactionKey; integer; The unique identifier of the Permit, Planning application, or Business License application.
  • TransactionType; string; Identifies the source transaction type like permit, planning, business license, or case.
  • UpdateFlag; string; A switch to determine whether the user has access to update the row.
  • UserType; string; The type of user who added the related application, such as AGENCY or APPLICANT.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : publicSectorRelatedTransactionQueries

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRelatedTransactionQueries-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRelatedTransactionQueries-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRelatedTransactionQueries-item-response"
    }
}

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

Type: object

Show Source

• AddedDate: string (date-time)
  Read Only: true

  The unique identifier of the pre-application or business license consultation.
• AssignedUserName: string
  Read Only: true

  The user name of the assigned user for the related planning application.
• Classification: string
  Read Only: true

  Maximum Length: 12

  The classification of the related application like permit, planning application, or business license.
• ClassificationDescription: string
  Read Only: true

  Maximum Length: 255

  A description of the classification code of the current transaction.
• CoaCount: number
  Read Only: true

  Indicates the total number of conditions of approval applied on the related transaction.
• DeleteFlag: string
  Read Only: true

  Indicates whether the user has access to remove the related transaction row.
• Dependency: string
  Read Only: true

  Maximum Length: 40

  The dependency between related applications like ORA_PREAPP, ORA_REQ, or ORA_REL.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The comments added for the related transaction.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the related application was last updated.
• LinkedByName: string
  Read Only: true

  The user who linked the transaction to current application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualLinkFlag: string
  Read Only: true

  Maximum Length: 255

  The related transaction link is for neither the primary nor subapplication of the current application.
• OrderDate: string (date-time)
  Read Only: true

  The transaction change date of the parent transaction.
• OrderKey: integer
  Read Only: true

  The parent transaction key for the current transaction.
• ParPriFlag: string
  Read Only: true

  Maximum Length: 4

  The current application is the primary application for the related transaction.
• ParSubFlag: string
  Read Only: true

  Maximum Length: 4

  The current application is the sub-application for the related transaction.
• PriAppFlag: string
  Read Only: true

  Maximum Length: 1

  The related transaction is the primary application of the current application.
• PrimaryLinkFlag: string
  Read Only: true

  Maximum Length: 255

  The related transaction link is for the primary application of the current application.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The application type of the related application.
• RelatedKey: number
  Read Only: true

  The unique identifier of the related record transaction.
• RelTransactionType: string
  Read Only: true

  Maximum Length: 8

  Identifies the related transaction type like permit, planning application, business license, or case.
• ReltransCoaAppl: number
  Read Only: true

  Indicates total number conditions of approval applied on the current permit application from it's related planning application.
• RelTransId: string
  Read Only: true

  Maximum Length: 50

  The application identifier of the related application.
• RelTransKey: number
  Read Only: true

  The application key of the related application.
• RelTransTypeCode: string
  Read Only: true

  Maximum Length: 20

  The application type code for the related application.
• RelTransTypeId: string
  Read Only: true

  Maximum Length: 30

  The application type identifier for the related application.
• Status: string
  Read Only: true

  Maximum Length: 15

  The status of the related application.
• SubAppFlag: string
  Read Only: true

  Maximum Length: 1

  The related transaction is the sub-application of the current application.
• SubLinkFlag: string
  Read Only: true

  Maximum Length: 255

  The related transaction link is for the subapplication of the current application.
• SystemStatus: string
  Read Only: true

  Maximum Length: 15

  The system status of the related application.
• TransactionId: string
  Read Only: true

  Maximum Length: 50

  The permit, planning application, or business license identifier.
• TransactionKey: integer
  Read Only: true

  The unique identifier of the Permit, Planning application, or Business License application.
• TransactionType: string
  Read Only: true

  Maximum Length: 8

  Identifies the source transaction type like permit, planning, business license, or case.
• TransCoaAppl: number
  Read Only: true

  Indicates the total number of conditions of approval applied on related permit application from current planning application.
• UpdateFlag: string
  Read Only: true

  A switch to determine whether the user has access to update the row.
• UserType: string
  Read Only: true

  The type of user who added the related application, such as AGENCY or APPLICANT.

{
    "type":"object",
    "properties":{
        "PriAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The related transaction is the primary application of the current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the source transaction type like permit, planning, business license, or case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the Permit, Planning application, or Business License application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The comments added for the related transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The related transaction is the sub-application of the current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransId":{
            "maxLength":"50",
            "type":"string",
            "description":"The application identifier of the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"A description of the classification code of the current transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AddedDate":{
            "type":"string",
            "description":"The unique identifier of the pre-application or business license consultation.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"string",
            "description":"A switch to determine whether the user has access to update the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The application type of the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoaCount":{
            "type":"number",
            "description":"Indicates the total number of conditions of approval applied on the related transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"12",
            "type":"string",
            "description":"The classification of the related application like permit, planning application, or business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReltransCoaAppl":{
            "type":"number",
            "description":"Indicates total number conditions of approval applied on the current permit application from it's related planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the related transaction type like permit, planning application, business license, or case.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The system status of the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryLinkFlag":{
            "maxLength":"255",
            "type":"string",
            "description":"The related transaction link is for the primary application of the current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedKey":{
            "type":"number",
            "description":"The unique identifier of the related record transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUserName":{
            "type":"string",
            "description":"The user name of the assigned user for the related planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManualLinkFlag":{
            "maxLength":"255",
            "type":"string",
            "description":"The related transaction link is for neither the primary nor subapplication of the current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Dependency":{
            "maxLength":"40",
            "type":"string",
            "description":"The dependency between related applications like ORA_PREAPP, ORA_REQ, or ORA_REL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubLinkFlag":{
            "maxLength":"255",
            "type":"string",
            "description":"The related transaction link is for the subapplication of the current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"string",
            "description":"Indicates whether the user has access to remove the related transaction row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The permit, planning application, or business license identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderDate":{
            "type":"string",
            "description":"The transaction change date of the parent transaction.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParSubFlag":{
            "maxLength":"4",
            "type":"string",
            "description":"The current application is the sub-application for the related transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The application type identifier for the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParPriFlag":{
            "maxLength":"4",
            "type":"string",
            "description":"The current application is the primary application for the related transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransKey":{
            "type":"number",
            "description":"The application key of the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedByName":{
            "type":"string",
            "description":"The user who linked the transaction to current application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The application type code for the related application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserType":{
            "type":"string",
            "description":"The type of user who added the related application, such as AGENCY or APPLICANT.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderKey":{
            "type":"integer",
            "description":"The parent transaction key for the current transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransCoaAppl":{
            "type":"number",
            "description":"Indicates the total number of conditions of approval applied on related permit application from current planning application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the related application was last updated.",
            "format":"date-time",
            "nullable":true,
            "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