Get all activity groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups
Request
Query Parameters
-
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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 activity group that match the specified search criteria.
Finder Variables:- ActivityGroupId; string; The unique identifier of the activity group.
- AgencyId; integer; The unique identifier of the agency associated with this activity group.
- Classification; string; The unique identifier of the classification associated with the activity group.
- simpleSearchFinder: Finds the activity group that match the specified search criteria.
Finder Variables:- value; string; Finds the activity group that match the specified search criteria.
- PrimaryKey: Finds the activity group that match the specified search criteria.
-
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.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
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 fields. 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
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActivityGroupId; string; The unique identifier for the activity group.
- ActivityGroupName; string; The activity group name.
- AgencyId; integer; The unique identifier of the agency associated with the activity group.
- Classification; string; The applicable offering.
- Description; string; The activity group description.
- EnabledFlag; boolean; Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity.
-
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".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorActivityGroups
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorActivityGroups-item-response
Type:
Show Source
object
-
ActivityGroupId: string
Maximum Length:
30
The unique identifier for the activity group. -
ActivityGroupLine: array
Activity Group Lines
Title:
Activity Group Lines
The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application. -
ActivityGroupName: string
Maximum Length:
250
The activity group name. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the activity group. -
Classification: string
Maximum Length:
50
Default Value:PZ
The applicable offering. -
Description: string
Maximum Length:
1000
The activity group description. -
EnabledFlag: boolean
Maximum Length:
1
Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Activity Group Lines
Type:
array
Title:
Activity Group Lines
The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorActivityGroups-ActivityGroupLine-item-response
Type:
Show Source
object
-
ActivityGroupId: string
Title:
Activity Group ID
Maximum Length:30
The unique identifier for the activity group associated with the group line. -
ActivityId: string
Title:
Activity ID
Maximum Length:50
The unique identifier for the activity. -
ActivityName: string
Read Only:
true
Maximum Length:250
The activity name. -
ActivityPriority: integer
(int32)
The priority of the activity.
-
ActivityType: string
Maximum Length:
30
The activity type associated with the group line. -
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the activity group line. -
DueDateAdjust: string
Maximum Length:
30
Default Value:ORA_ACT_NA
This indicates whether the due date calculation should be adjusted to the prior or next day based on if the due date falls on a weekend or a holiday. -
DuedateBasis: string
Title:
Base Date
Maximum Length:30
The base date used for due date calculation. -
DuedateDuration: integer
(int32)
The due date duration.
-
DurationUom: string
Maximum Length:
30
The unit of measure for due date duration. -
EnabledFlag: boolean
Title:
Redo Activity
Maximum Length:1
Indicates whether the activity group line is enabled for use. Valid values are Y for enabled activity and N for disabled activity. -
ExclDueDateCalc: string
Maximum Length:
30
Default Value:ORA_ACT_NA
This indicates how the due date calculation will be carried out whether to exclude weekends and holidays. -
LeadLagIndicator: string
Maximum Length:
30
Indicates whether the due date is before or after the base date. Valid values are Days before base date and Days after base date. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RedoFlag: boolean
Maximum Length:
1
Indicates whether an activity retrigger is required. The valid values are Y and N. -
ResubmitFlag: boolean
Title:
Allow Resubmission
Maximum Length:1
Indicates whether the activity can be submitted. The default value is false. -
TranStatus: string
Maximum Length:
500
Default Value:The transaction status associated with the activity. -
TranType: string
Maximum Length:
30
Default Value:The transaction type of the event trigger.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.