Get an activity group
get
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}
Request
Path Parameters
-
publicSectorActivityGroupsUniqID: integer
This is the hash key of the attributes which make up the composite key--- ActivityGroupId, AgencyId and Classification ---for the Activity Groups resource and used to uniquely identify an instance of Activity Groups. The client should not generate the hash key value. Instead, the client should query on the Activity Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Groups.
For example: publicSectorActivityGroups?q=ActivityGroupId=<value1>;AgencyId=<value2>;Classification=<value3>
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 : publicSectorActivityGroups-item
Type:
Show Source
object
-
ActivityGroupId(optional):
string
Maximum Length:
30
The unique identifier for the activity group. -
ActivityGroupLine(optional):
array Activity Group Lines
Title:
Activity Group Lines
The activity groups resource is used to create, update, and delete an activity group associated with a planning and zoning application. -
ActivityGroupName(optional):
string
Maximum Length:
250
The activity group name. -
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the activity group.
-
Classification(optional):
string
Maximum Length:
50
The applicable offering. -
Description(optional):
string
Maximum Length:
1000
The activity group description. -
EnabledFlag(optional):
boolean
Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity.
-
links(optional):
array Items
Title:
Items
Link Relations
Nested Schema : Activity Group Lines
Type:
array
Title:
Activity Group Lines
The activity groups resource is used to create, update, and delete an activity group associated with a planning and zoning application.
Show Source
Nested Schema : publicSectorActivityGroups-ActivityGroupLine-item
Type:
Show Source
object
-
ActivityGroupId(optional):
string
Title:
Activity Group ID
Maximum Length:30
The unique identifier for the activity group associated with the group line. -
ActivityId(optional):
string
Title:
Activity ID
Maximum Length:50
The unique identifier for the activity. -
ActivityName(optional):
string
Maximum Length:
250
The activity name. -
ActivityPriority(optional):
integer(int32)
The priority of the activity.
-
ActivityType(optional):
string
Maximum Length:
30
The activity type associated with the group line. -
AgencyId(optional):
integer(int32)
The unique identifier of the agency associated with the activity group line.
-
DuedateBasis(optional):
string
Title:
Base Date
Maximum Length:30
The base date used for due date calculation. -
DuedateDuration(optional):
integer(int32)
The due date duration.
-
DurationUom(optional):
string
Maximum Length:
30
The unit of measure for due date duration. -
EnabledFlag(optional):
boolean
Title:
Redo Activity
Indicates whether the activity group line is enabled for use. Valid values are Y for enabled activity and N for disabled activity. -
LeadLagIndicator(optional):
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(optional):
array Items
Title:
Items
Link Relations -
RedoFlag(optional):
boolean
Indicates whether an activity retrigger is required. The valid values are Y and N.
-
ResubmitFlag(optional):
boolean
Title:
Allow Resubmission
Indicates whether the activity can be submitted. The default value is false. -
TranStatus(optional):
string
Maximum Length:
500
The transaction status associated with the activity. -
TranType(optional):
string
Maximum Length:
30
The transaction type of the event trigger.
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.