Get a parcel genealogy transaction header
get
/fscmRestApi/resources/11.13.18.05/publicSectorParcelTransactionHeaders/{ParcelTrxKey}
Request
Path Parameters
-
ParcelTrxKey: integer
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorParcelTransactionHeaders-item
Type:
Show Source
object
-
ChildParcel(optional):
string
Maximum Length:
30
The child parcel of the parcel genealogy transaction if only a single child is specified. -
CreationDate(optional):
string(date-time)
The date and time the parcel genealogy transaction was created.
-
LastUpdateDate(optional):
string(date-time)
The user who last updated the parcel genealogy transaction.
-
links(optional):
array Items
Title:
Items
Link Relations -
MigratedDataFlag(optional):
string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
ParcelTransactionDetail(optional):
array Parcel genealogy transaction details
Title:
Parcel genealogy transaction details
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction. -
ParcelTrxDttm(optional):
string(date-time)
The date and time when the parcel genealogy transaction was created.
-
ParcelTrxKey(optional):
integer(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
-
ParcelTrxPuid(optional):
string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction. -
ParcelTrxStatus(optional):
string
Maximum Length:
10
The status of the parcel genealogy transaction. Valid values include Pending and Complete. -
ParcelTrxType(optional):
string
Maximum Length:
20
The type of parcel genealogy transaction. Valid values include Split, Merge and Adjust. -
ParentParcel(optional):
string
Maximum Length:
30
The parent parcel of the parcel genealogy transaction if only a single parent is specified. -
PreviousState(optional):
string
Maximum Length:
20
The previous state of this row. -
Temporary(optional):
string
Maximum Length:
1
Indicates whether the data in this row is temporary.
Nested Schema : Parcel genealogy transaction details
Type:
array
Title:
Parcel genealogy transaction details
The parcel genealogy transaction detail resource is used to view, create, delete, or modify parcel genealogy transaction details and associate them with a parcel genealogy transaction.
Show Source
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.
Nested Schema : publicSectorParcelTransactionHeaders-ParcelTransactionDetail-item
Type:
Show Source
object
-
CreationDate(optional):
string(date-time)
The date and time when the parcel genealogy transaction detail was created.
-
ExistingParcel(optional):
string
Maximum Length:
1
Indicates whether parcel was previously created in the system or it is being created with the parcel genealogy transaction. -
FinalParcelIdEntered(optional):
string
Maximum Length:
30
The final parcel number (APN) typically assigned by the county. -
LastUpdateDate(optional):
string(date-time)
The date and time when the parcel genealogy transaction detail was last updated.
-
links(optional):
array Items
Title:
Items
Link Relations -
MigratedDataFlag(optional):
string
Maximum Length:
3
Indicates whether the transaction was created online or migrated from a legacy system. -
ParcelId(optional):
integer(int64)
The unique identifier of the parcel of real estate in the genealogy transaction. Mandatory system-generated value.
-
ParcelIdEntered(optional):
string
Maximum Length:
30
The unique identifier of the child parcel in the genealogy transaction. Mandatory user supplied value. -
ParcelTrxDtlKey(optional):
integer(int64)
The unique identifier of the parcel genealogy transaction detail. Mandatory system-generated value.
-
ParcelTrxDtlPuid(optional):
string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction detail. -
ParcelTrxKey(optional):
integer(int64)
The unique identifier of the parcel genealogy transaction. Mandatory system-generated value.
-
ParcelTrxPuid(optional):
string
Maximum Length:
480
The public unique identifier of the parcel genealogy transaction. -
PreviousState(optional):
string
Maximum Length:
20
The previous state of this row. -
ProvisionalParcelIdEntered(optional):
string
Maximum Length:
30
The temporary parcel number supplied by the user to be used until the final parcel number (APN) is available. -
Relationship(optional):
string
Maximum Length:
15
The relationship of the parcels included in a genealogy transaction. -
Temporary(optional):
string
Maximum Length:
1
Indicates whether the data in this row is temporary.