Get all activity communication items
get
/fscmRestApi/resources/11.13.18.05/publicSectorActivityCommunications
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 activity communication data using the specified record key. Finder Variables:
- ActivityLogKey; integer; The unique identifier for the record key.
- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds activity communication data using 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 : publicSectorActivityCommunications
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 : publicSectorActivityCommunications-item
Type:
Show Source
object
-
ActivityGroupId(optional):
string
Maximum Length:
30
The identifier for the activity group ID. -
ActivityGroupName(optional):
string
Title:
Activity Group
Maximum Length:250
The activity group name. -
ActivityId(optional):
string
Title:
Activity ID
Maximum Length:50
The identifier for the activity. -
ActivityLogId(optional):
string
Maximum Length:
65
The unique identifier for the activity log ID. -
ActivityLogKey(optional):
integer(int64)
The unique identifier for the entitlement activity log key.
-
ActivityName(optional):
string
Title:
Activity
Maximum Length:250
The activity name. -
ActivityStatus(optional):
string
Title:
Activity Status
Maximum Length:30
The status of the activity. -
ActualCompletionDate(optional):
string(date)
Title:
Completion Date
The date when the activity is completed. -
ApplExpirationDate(optional):
string(date-time)
Title:
Application Expiration Date
The date when the license or planning is no longer valid. -
Applicant(optional):
integer(int64)
The party ID of the plannng applicant.
-
ApplicantBizProfileId(optional):
integer(int64)
Title:
Business Profile
The business profile used by the applicant. -
ApplicantProfileId(optional):
integer(int64)
Title:
Applicant Profile
The user profile of the applicant. -
AssigneeEmail(optional):
string
Title:
Assigned Planner Email
The email for the assigned planner. -
AssigneeId(optional):
integer(int64)
The assigned planner ID.
-
AssigneeName(optional):
string
Title:
Assigned Planner Name
The name of the assigned planner. -
AssigneePhone(optional):
string
Title:
Assigned Planner Phone
The phone for the assigned planner. -
AssigneeUserid(optional):
string
Maximum Length:
64
The assigned planner user ID. -
AttributeCategory(optional):
string
Maximum Length:
30
The attribute category information. -
BalanceDue(optional):
string
Title:
Balance Due
The balance due for the planning application. -
BaseDate(optional):
string(date)
The base date field used to calculate the activity due date.
-
Classification(optional):
string
Title:
Classification
Maximum Length:3
The planning application classification. -
DuedateBasis(optional):
string
Maximum Length:
30
The base date field used to calculate the activity due date. -
EmailAddress1(optional):
string
Title:
Applicant Email 1
Maximum Length:320
The first email address of the planning applicant. -
EmailAddress2(optional):
string
Title:
Applicant Email 2
Maximum Length:320
The second email address of the planning applicant. -
links(optional):
array Items
Title:
Items
Link Relations -
LnpRecordId(optional):
string
Title:
Application ID
Maximum Length:50
The identifier for the planning record. -
LnpRecordKey(optional):
integer(int64)
The key identifier for the planning record.
-
Meaning(optional):
string
Maximum Length:
80
The description of the base date. -
OccuranceCount(optional):
integer(int32)
Title:
Activity Count
The activity occurence count. -
OrganizationName(optional):
string
Maximum Length:
360
The business name of the applicant. For example, a contractor enters his or her contracting business name. -
ParcelAddress1(optional):
string
Title:
Parcel Address 1
Maximum Length:240
The first line of the parcel or property address. -
ParcelAddress2(optional):
string
Title:
Parcel Address 2
Maximum Length:240
The second line of the parcel or property address. -
ParcelAddressKey(optional):
integer(int64)
The parcel address key.
-
ParcelCity(optional):
string
Title:
Parcel City
Maximum Length:60
The city in the parcel or property address. -
ParcelCountry(optional):
string
Title:
Parcel Country
Maximum Length:60
The country in the parcel or property address. -
ParcelCounty(optional):
string
Title:
Parcel County
Maximum Length:60
The county in the parcel or property address. -
ParcelId(optional):
integer(int64)
The identifier of the record parcel.
-
ParcelKey(optional):
integer(int64)
The key of the record parcel.
-
ParcelPostalCode(optional):
string
Title:
Parcel Postal Code
Maximum Length:60
The postal code in the parcel or property address. -
ParcelProvince(optional):
string
Title:
Parcel Province
Maximum Length:60
The province in the parcel or property address. -
ParcelState(optional):
string
Title:
Parcel State
Maximum Length:60
The state in the parcel or property address. -
ParcelType(optional):
string
Maximum Length:
30
The type of the current parcel. -
PersonName(optional):
string
Title:
Applicant Name
Maximum Length:450
The planning applicant name. -
PhoneAreaCode(optional):
string
Title:
Applicant Phone Area Code
Maximum Length:10
The area code in the phone number of the planning applicant. -
PhoneCountryCode(optional):
string
Title:
Applicant Phone Country Code
Maximum Length:10
The country code in the phone number of the planning applicant. -
PhoneExtension(optional):
string
Title:
Applicant Phone Extension
Maximum Length:20
The phone number extension for the planning applicant. -
PhoneNumber(optional):
string
Title:
Applicant Phone Number
Maximum Length:40
The planning applicant phone number. -
PlannedDueDate(optional):
string(date)
Title:
Planned Due Date
The activity planned due date. -
PlanningDescription(optional):
string
Title:
Application Description
Maximum Length:1000
The description of the planning type. -
Planningstatus(optional):
string
Title:
Application Status
Maximum Length:15
The status of the planning record. -
ProcessId(optional):
number
The transaction workflow process ID.
-
ProjectKey(optional):
integer(int64)
Title:
Project
The project name information for a planning -
PropertyDescription(optional):
string
Maximum Length:
240
The property description. -
RecordStatus(optional):
string
Maximum Length:
15
The status of the record. -
RecordType(optional):
string
Title:
Application Type
Maximum Length:100
The planning type. Agencies define the types of planning that they administer, for example, Residential Addition. -
RecordTypeId(optional):
string
Maximum Length:
30
The identifier for a record type. -
Subclassification(optional):
string
Title:
Subclassification
Maximum Length:10
The planning application subclassification. -
SubmitDate(optional):
string(date-time)
Title:
Submission Date
The date when the license and planning transaction was submitted. Used in the application information component of the planning Designer. -
SystemStatus(optional):
string
Maximum Length:
15
The system status. -
TransactionId(optional):
string
Maximum Length:
50
The transaction reference ID. -
TransactionKey(optional):
integer(int64)
The transaction reference key.
-
TransactionReferenceId(optional):
string
Maximum Length:
50
The transaction reference ID. -
TransactionReferenceKey(optional):
integer(int64)
The transaction reference key.
-
TranType(optional):
string
Maximum Length:
30
The transaction type of the event trigger. -
UpdatedByUser(optional):
string
Maximum Length:
64
The user who last updated the activity.
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.