Get all activities
get
/fscmRestApi/resources/11.13.18.05/publicSectorPlannerActivities
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:- OverdueActivitiesFinder: Finds the overdue activities that match the specified criteria. Finder Variables:
- bAssigneeId; integer; The unique identifier for the assignee.
- bCurrentDate; string; The current date.
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- NextWeekActivitiesFinder: Finds next week's activities that match the specified criteria. Finder Variables:
- bAssigneeId; integer; The unique identifier for the assignee.
- bNextWeekMonday; string; The Monday date for next week.
- bNextWeekSunday; string; The Sunday date for next week.
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- ThisWeekActivitiesFinder: Finds this week's activities that match the specified criteria. Finder Variables:
- bAssigneeId; integer; The unique identifier for the assignee.
- bMondayDate; string; The Monday date for this week.
- bSundayDate; string; The Sunday date for this week.
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- TodayActivitiesFinder: Finds today's activities that match the specified criteria. Finder Variables:
- bAssigneeId; integer; The unique identifier for the assignee.
- bCurrentDate; string; The current date.
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- simpleSearchFinder: Finds the activities that match the specified primary key criteria. Finder Variables:
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- AssignedActivitiesFinder: Finds activities where the planner matches the specified key criteria. Finder Variables:
- bAssigneeId; integer; The unique identifier for the assignee.
- value; string; The filter values to be applied when finding activities. Options include activity name, ID, application ID, status, description, property, address, or city.
- PrimaryKey: Finds the activities that match the specified primary key criteria. Finder Variables:
- ActivityLogKey; integer; The unique identifier for the activity log.
- OverdueActivitiesFinder: Finds the overdue activities that match the specified criteria. 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 : publicSectorPlannerActivities
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 : publicSectorPlannerActivities-item
Type:
Show Source
object
-
ActivityGroupId(optional):
string
Maximum Length:
30
The unique identifier for the activity group. -
ActivityId(optional):
string
Maximum Length:
50
The unique identifier for the activity. -
ActivityLogId(optional):
string
Maximum Length:
65
A logical ID for the activity log transaction. -
ActivityLogKey(optional):
integer(int64)
The unique identifier for an activity. This number is created using autonumbering.
-
ActivityName(optional):
string
Maximum Length:
255
The activity log short name. -
ActivityStatus(optional):
string
Maximum Length:
30
The activity status. -
ActivityStatusDesc(optional):
string
Maximum Length:
15
The description for an activity status. -
ActualCompletionDate(optional):
string(date-time)
The actual completion date for an activity.
-
Address1(optional):
string
Maximum Length:
240
The first line of the address. -
Address2(optional):
string
Maximum Length:
240
The second line of the address. -
Address3(optional):
string
Maximum Length:
240
The third line of the address. -
Address4(optional):
string
Maximum Length:
240
The fourth line of the address. -
AgencyId(optional):
integer(int32)
The unique identifier for the agency.
-
ApplicationDescription(optional):
string
Maximum Length:
1000
The application description. -
ApplicationStatus(optional):
string
Maximum Length:
15
The application status. -
AssignedTo(optional):
string
Maximum Length:
240
The planner ID to whom the activity is assigned. -
AssigneeId(optional):
integer(int64)
The PERSON_ID key of the person assigned to work on the activity. This ID comes from the table PER_USERS.
-
AssigneeUserid(optional):
string
Maximum Length:
64
The user name of the person assigned to work on the activity. -
BaseDate(optional):
string(date-time)
The base date for an activity.
-
City(optional):
string
Maximum Length:
60
The city for the address. -
Country(optional):
string
Maximum Length:
3
The country for the address. -
County(optional):
string
Maximum Length:
60
The county of the address. -
CurrentRowFlag(optional):
string
Maximum Length:
1
Indicates the current row for the activity. -
Description(optional):
string
Maximum Length:
1000
The activity log description. -
DuedateBasis(optional):
string
Maximum Length:
30
The unique identifier for the due date basis calculation. -
DuedateBasisDesc(optional):
string
Maximum Length:
80
The description for due date basis. -
DuedateDuration(optional):
integer(int32)
The due date duration.
-
LeadLagIndicator(optional):
string
Maximum Length:
30
The unique identifier for lead lag. -
links(optional):
array Items
Title:
Items
Link Relations -
OccuranceCount(optional):
integer(int32)
The occurrence count of an activity.
-
PlannedDueDate(optional):
string(date-time)
The due date for an activity.
-
PostalCode(optional):
string
Maximum Length:
60
The postal code for the address. -
RecordId(optional):
string
Maximum Length:
50
A logical ID for the planning and zoning application transaction. -
RecordKey(optional):
integer(int64)
The unique identifier for an application. This number is created using autonumbering.
-
RecordType(optional):
string
Maximum Length:
100
The description for an application. -
RecordTypeCode(optional):
string
Maximum Length:
20
The unique identifier for an application type. -
RecordTypeId(optional):
string
Maximum Length:
30
The logical ID for the application. -
RedoFlag(optional):
string
Maximum Length:
1
Indicates a redo activity. -
ResubmitFlag(optional):
string
Maximum Length:
1
Indicates whether the activity can be resubmitted. -
ResubmittedFlag(optional):
string
Maximum Length:
1
Indicates whether the activity has been resubmitted. -
State(optional):
string
Maximum Length:
60
The state for the address. -
StreetName(optional):
string
Maximum Length:
240
The street name of the address. -
StreetNumber(optional):
string
Maximum Length:
20
The street number of the address. -
Subclassification(optional):
string
Maximum Length:
10
The application type classification that represents the planning and zoning application. -
SystemStatus(optional):
string
Maximum Length:
15
The system status. -
TransactionReferenceId(optional):
string
Maximum Length:
50
A logical ID for the transaction. -
TransactionReferenceKey(optional):
integer(int64)
The unique identifier for planning and zoning transaction. This number is created using autonumbering.
-
TranType(optional):
string
Maximum Length:
30
The type of transaction for an application. -
UnitNumber(optional):
string
Maximum Length:
30
The unit number of the address. -
UpdatedByUser(optional):
string
Maximum Length:
64
The name of the user who last updated the row.
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.