Get all related transactions
get
/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 transactions in the system that can be linked to the current transaction. Finder Variables:
- RelatedKey; integer; The unique identifier of the related transaction record.
- PrimaryKey: Finds the transactions in the system that can be linked to the current transaction. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRelatedTransactions
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRelatedTransactions-item
Type:
Show Source
object
-
AddedDate(optional):
string(date-time)
The date on which the applications were linked.
-
Classification(optional):
string
Maximum Length:
3
The classification of the type of application. -
Comments(optional):
string
Title:
Comments
Maximum Length:1000
The comments entered by the agency staff in the planning and zoning application. -
Dependency(optional):
string
Maximum Length:
10
The identifier of the type of dependency between the linked planning and zoning applications. -
links(optional):
array Items
Title:
Items
Link Relations -
PriAppFlag(optional):
string
Maximum Length:
1
The identifier of the ralated transaction, which is the primary application. -
RelatedKey(optional):
integer(int64)
The unique identifier of the related transaction record.
-
RelatedPuid(optional):
string
Maximum Length:
480
The public unique identifier of a migrated related record transaction. -
RelTransactionType(optional):
string
Maximum Length:
8
Identifies the related transaction type like permit, planning, business license, or case. -
RelTransId(optional):
string
Title:
Link Existing Application
Maximum Length:50
The unique identifier of the related transaction. -
RelTransKey(optional):
integer(int64)
The unique identifier of the planning and zoning application that is being linked.
-
RelTransPuid(optional):
string
Maximum Length:
64
The public unique identifier of a migrated planning and zoning application that is being linked. -
RelTransTypeCode(optional):
string
Title:
Application Type
Maximum Length:20
The unique identifier of the related transaction type code. -
RelTransTypeId(optional):
string
Maximum Length:
30
The unique identifier of the related transaction type. -
SubAppFlag(optional):
string
Maximum Length:
1
The identifier of the ralated transaction, which is the sub-application. -
TransactionId(optional):
string
Maximum Length:
50
The unique identifier of the planning and zoning application. -
TransactionKey(optional):
integer(int64)
The unique identifier of the planning and zoning application.
-
TransactionPuid(optional):
string
Maximum Length:
64
The public unique identifier of a migrated planning and zoning application. -
TransactionType(optional):
string
Maximum Length:
8
Identifies the source transaction type like permit, planning, business license, or case.
Nested Schema : link
Type:
Show Source
object
-
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.