Get all workflow communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications
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 workflow communication data with the specified record key. Finder Variables:
- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds workflow communication data with the specified record key. 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 : publicSectorWorkflowCommunications
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 : publicSectorWorkflowCommunications-item
Type:
Show Source
object
-
AboutToExpireDate(optional):
string(date-time)
Title:
About to Expire Date
The date when the notification about an expiring license or permit is sent. -
AddressKey(optional):
integer(int64)
The parcel address key.
-
AgencyId(optional):
integer(int32)
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
-
AppAcceptDate(optional):
string(date-time)
Title:
Acceptance Date
Identifies the accepted date for the permit application. -
ApplAteDate(optional):
string(date-time)
Title:
Application About to Expire Date
Identifies the date on which an about-to-expire notification is sent for the permit application. -
ApplExpirationDate(optional):
string(date-time)
Title:
Application Expiration Date
The date the application expires. -
Applicant(optional):
integer(int64)
The party ID of the permit applicant.
-
ApplicantAddress1(optional):
string
Title:
Applicant Address Line 1
Maximum Length:240
The first line of the permit applicant address. -
ApplicantAddress2(optional):
string
Title:
Applicant Address Line 2
Maximum Length:240
The second line of the permit applicant address. -
ApplicantBizProfileId(optional):
integer(int64)
The business profile used by the applicant.
-
ApplicantCity(optional):
string
Title:
Applicant City
Maximum Length:60
The city in the permit applicant address. -
ApplicantCountry(optional):
string
Title:
Applicant Country
Maximum Length:3
The country in the permit applicant address. -
ApplicantCounty(optional):
string
Title:
Applicant County
Maximum Length:60
The county in the permit applicant address. -
ApplicantEmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The first email address of the permit applicant. -
ApplicantEmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The second email address of the permit applicant. -
ApplicantPersonName(optional):
string
Title:
Applicant Full Name
Maximum Length:450
The permit applicant name. -
ApplicantPhoneAreaCode(optional):
string
Title:
Applicant Phone Area Code
Maximum Length:10
The area code in the phone number of the permit applicant. -
ApplicantPhoneCountryCode(optional):
string
Title:
Applicant Phone Country Code
Maximum Length:10
The country code in the phone number of the permit applicant. -
ApplicantPhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The phone number extension for the permit applicant. -
ApplicantPhoneNumber(optional):
string
Title:
Applicant Phone Number
Maximum Length:40
The permit applicant phone number. -
ApplicantPostalCode(optional):
string
Title:
Applicant Postal Code
Maximum Length:60
The postal code in the permit applicant address. -
ApplicantProfileId(optional):
integer(int64)
The user profile of the applicant.
-
ApplicantProvince(optional):
string
Title:
Applicant Province
Maximum Length:60
The province in the permit applicant address. -
ApplicantState(optional):
string
Title:
Applicant State
Maximum Length:60
The state in the permit applicant address. -
ApplicantUserId(optional):
string
Title:
Applicant User ID
Maximum Length:20
The user ID of the permit applicant. -
BalanceDue(optional):
string
Title:
Fees Balance Due
The total fees balance due for the permit application. -
CancelledByName(optional):
string
Title:
Canceled by Name
Identifies the user name of the person who canceled the permit application. -
CancelledCreatedBy(optional):
string
Title:
Canceled by User ID
Maximum Length:64
Identifies the user ID of the person who canceled the permit application. -
CancelledCreationDate(optional):
string(date-time)
Title:
Cancellation Date
Identifies the cancelation date of the permit application. -
CancelledReason(optional):
string
Title:
Cancellation Reason
Maximum Length:1000
Identifies the reason for the cancelation of the permit application. -
Classification(optional):
string
Maximum Length:
3
The record classification. The classifications can be permit, business license, professional license, or planning and zoning. -
ClassificationMeaning(optional):
string
Title:
Classification
Maximum Length:80
Identifies the classification of the permit application type. -
CreatedBy(optional):
string
Title:
Created by User ID
Maximum Length:64
Identifies the user ID of the person who created the permit application. -
CreatedByName(optional):
string
Title:
Created by Name
Identifies the user name of the person who created the permit application. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
Identifies the date on which the permit application was created. -
CurrencyCode(optional):
string
Title:
Currency
Maximum Length:3
Identifies the currency code. -
DelinquentDate(optional):
string(date-time)
The date the license becomes delinquent.
-
DistrictName(optional):
string
Maximum Length:
50
The name of the district in which the property is located. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The date the license or permit is no longer valid. -
ExpirationGraceDate(optional):
string(date-time)
Title:
Grace Period Date
Identifies the expiration grace date for the permit applciation. -
ExpirationStatus(optional):
string
Title:
Expiration Status
Maximum Length:15
Identifies the expiration status of the permit application. -
GenFloorAreaAddl(optional):
number
Title:
Additional Floor Area
The additional floor area for construction. The floor area refers to the square footage of the construction area. Used in the construction information component of the Permit Designer. -
GenFloorAreaExist(optional):
number
Title:
Existing Floor Area
The area of the existing floor in the building. Used in the construction information component of the Permit Designer. -
GenFloorAreaTotal(optional):
number
Title:
Total Floor Area
The total floor area under construction. Used in the construction information component of the Permit Designer. -
GenJobCost(optional):
number
Title:
Job Cost
The cost of the construction job. Used in the construction information component of the Permit Designer. -
GenNewFloorAreaClass(optional):
string
Title:
New Floor Area Classification
Maximum Length:50
The classification of the new floor area. Used in the construction information component of the Permit Designer. -
GenTotalNumStories(optional):
number
Title:
Total Number of Stories
The total number of stories of the structure under construction. Used in the construction information component of the Permit Designer. -
GenTypeConstruction(optional):
string
Title:
Type of Construction
Maximum Length:100
The type of construction. Used in the construction information component of the Permit Designer. -
GenTypeOfUse(optional):
string
Title:
Type of Use
Maximum Length:100
The intended use of the construction. Used in the construction information component of the Permit Designer. -
GenTypeOfWork(optional):
string
Title:
Type of Work
Maximum Length:100
The type of construction work. Used in the construction information component of the Permit Designer. -
IssueDate(optional):
string(date-time)
Title:
Issue Date
The date the license or permit was issued. Used in the application information component of the Permit Designer. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
Identifies the last updated date of the permit application. -
LastUpdatedBy(optional):
string
Title:
Last Updated by User ID
Maximum Length:64
Identifies the user ID of the person who last updated the permit application. -
LastUpdatedByName(optional):
string
Title:
Last Updated by Name
Identifies the user name of the person who last updated the permit application. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Permit ID
Maximum Length:50
The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey(optional):
integer(int64)
The unique identifier for the record.
-
OrganizationName(optional):
string
Title:
Business Name
Maximum Length:360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
Originator(optional):
string
Title:
Originator
Maximum Length:3
Identifies the origantor of the permit application. -
Owner(optional):
string
Title:
Property Owner Name
Maximum Length:150
The primary or only owner of the parcel or property. -
OwnerEmailId(optional):
string
Title:
Property Owner Email
Maximum Length:50
The parcel owner email address. -
OwnerId(optional):
integer(int64)
Title:
Property Owner
The owner ID of the record parcel owner. -
OwnerKey(optional):
integer(int64)
The owner key of the record parcel owner.
-
ParcelAddress1(optional):
string
Title:
Property Address Line 1
Maximum Length:240
The first line of the parcel or property address. -
ParcelAddress2(optional):
string
Title:
Property Address Line 2
Maximum Length:240
The second line of the parcel or property address. -
ParcelCity(optional):
string
Title:
Property City
Maximum Length:60
The city in the parcel or property address. -
ParcelCountry(optional):
string
Title:
Property Country
Maximum Length:60
The country in the parcel or property address. -
ParcelCounty(optional):
string
Title:
Property County
Maximum Length:60
The county in the parcel or property address. -
ParcelId(optional):
integer(int64)
Title:
Parcel
The identifier of the record parcel. -
ParcelKey(optional):
integer(int64)
The key of the record parcel.
-
ParcelPostalCode(optional):
string
Title:
Property Postal Code
Maximum Length:60
The postal code in the parcel or property address. -
ParcelProvince(optional):
string
Title:
Property Province
Maximum Length:60
The province in the parcel or property address. -
ParcelState(optional):
string
Title:
Property State
Maximum Length:60
The state in the parcel or property address. -
ParcelType(optional):
string
Title:
Parcel Type
Maximum Length:30
The type of the current parcel. -
PermitDescription(optional):
string
Title:
Permit Description
Maximum Length:300
The description of the permit type. -
PermitStatus(optional):
string
Title:
Permit Status
Maximum Length:100
The status of the permit record. -
PersonFirstName(optional):
string
Title:
Applicant First Name
Maximum Length:150
The applicant first name. -
PersonLastName(optional):
string
Title:
Applicant Last Name
Maximum Length:150
The applicant last name. -
PersonMiddleName(optional):
string
Title:
Applicant Middle Name
Maximum Length:60
The applicant middle name. -
PersonTitle(optional):
string
Title:
Applicant Title
Maximum Length:60
The title of the contact. -
Primarycontactemail(optional):
string
Title:
Contact Email
Maximum Length:320
Identifies the email of the primary contact of the permit application. -
Primarycontactname(optional):
string
Title:
Contact Name
Maximum Length:450
Identifies the primary contact name of the permit application. -
Primarycontactpartyid(optional):
integer(int64)
Title:
Contact User ID
Identifies the party ID of the primary contact of the permit application. -
PrimaryContactPhonenumber(optional):
string
Title:
Contact Phone
Maximum Length:80
Identifies the phone number of the primary contact of the permit application. -
Primarycontacttype(optional):
string
Title:
Contact Type
Maximum Length:30
Identifies the contact type of the primary contact of the permit application. -
ProjectKey(optional):
integer(int64)
The project name information for a permit.
-
PropertyDescription(optional):
string
Title:
Property Description
Maximum Length:240
The property description. -
ReceivedDate(optional):
string(date-time)
Title:
Received Date
Identifies the received date for the permit application. -
RecordStatus(optional):
string
Maximum Length:
15
The status of the record. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The permit type. Agencies define the types of permits that they administer, for example, Residential Addition. -
RecordTypeId(optional):
string
Maximum Length:
30
The identifier for a record type. -
RenewalDate(optional):
string(date-time)
Title:
Renewal Date
The renewal date for the license or permit. -
RowType(optional):
string
Maximum Length:
30
The identifier for a record type. -
SecondaryOwner(optional):
string
Title:
Property Secondary Owner
Maximum Length:150
The secondary owner of the parcel or property. -
Subclassification(optional):
string
Maximum Length:
10
The subclassification code of the permit application type. -
SubclassificationMeaning(optional):
string
Title:
Subclassification
Maximum Length:80
Identifies the subclassification of the permit application type. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer. -
SubmittedBy(optional):
string
Title:
Submitted by User ID
Maximum Length:64
Identifies the user ID of the person who submitted the permit application. -
SubmittedByName(optional):
string
Title:
Submitted by Name
Identifies the user name of the person who submitted the permit application. -
SystemStatus(optional):
string
Maximum Length:
15
Identifies the system status of the permit application. -
TotalFees(optional):
string
Title:
Fees Total Amount
The total fees for the permit application. -
TotalPaid(optional):
string
Title:
Fees Total Paid
The total fees paid for the permit application. -
TotalPayable(optional):
string
Title:
Fees Total Payable
The total fees payable for the permit application. -
WithDrawnByName(optional):
string
Title:
Withdrawn by Name
Identifies the user name of the person who withdrew the permit application. -
WithdrawnCreatedBy(optional):
string
Title:
Withdrawn by User ID
Maximum Length:64
Identifies the user ID of the person who withdrew the permit application. -
WithdrawnCreatedDate(optional):
string(date-time)
Title:
Withdrawal Date
Identifies the withdrawal date of the permit application. -
WithdrawnReason(optional):
string
Title:
Withdrawal Reason
Maximum Length:1000
Identifies the reason for the withdrawal of the permit application.
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.