Create an activity group
post
/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActivityGroupId(required): 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(required): 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(required): 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.
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 : schema
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. -
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. -
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.
Response
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-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.
Links
- ActivityGroupLine
-
Parameters:
- publicSectorActivityGroupsUniqID:
$request.path.publicSectorActivityGroupsUniqID
The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application. - publicSectorActivityGroupsUniqID: