Jump to

• Request
• Response

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

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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.

{
    "required":[
        "ActivityGroupId",
        "ActivityGroupName",
        "EnabledFlag"
    ],
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity group description.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "ActivityGroupLine":{
            "title":"Activity Group Lines",
            "type":"array",
            "description":"The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.",
            "items":{
                "$ref":"#/components/schemas/publicSectorActivityGroups-ActivityGroupLine-item-post-request"
            }
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering.",
            "nullable":false,
            "default":"PZ"
        },
        "ActivityGroupName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity group name.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":false
        },
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group.",
            "nullable":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Activity Group Lines",
    "type":"array",
    "description":"The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.",
    "items":{
        "$ref":"#/components/schemas/publicSectorActivityGroups-ActivityGroupLine-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TranType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type of the event trigger.",
            "nullable":false,
            "default":" "
        },
        "ActivityPriority":{
            "type":"integer",
            "description":"The priority of the activity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group line.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "DuedateBasis":{
            "title":"Base Date",
            "maxLength":30,
            "type":"string",
            "description":"The base date used for due date calculation.",
            "nullable":false
        },
        "ResubmitFlag":{
            "title":"Allow Resubmission",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity can be submitted. The default value is false.",
            "nullable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the activity.",
            "nullable":false
        },
        "ActivityType":{
            "maxLength":30,
            "type":"string",
            "description":"The activity type associated with the group line.",
            "nullable":false
        },
        "ActivityGroupId":{
            "title":"Activity Group ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group associated with the group line.",
            "nullable":false
        },
        "ExclDueDateCalc":{
            "maxLength":30,
            "type":"string",
            "description":"This indicates how the due date calculation will be carried out whether to exclude weekends and holidays.",
            "nullable":false,
            "default":"ORA_ACT_NA"
        },
        "LeadLagIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the due date is before or after the base date. Valid values are Days before base date and Days after base date.",
            "nullable":false
        },
        "RedoFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N.",
            "nullable":false
        },
        "DurationUom":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure for due date duration.",
            "nullable":true
        },
        "DueDateAdjust":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_ACT_NA"
        },
        "TranStatus":{
            "maxLength":500,
            "type":"string",
            "description":"The transaction status associated with the activity.",
            "nullable":false,
            "default":" "
        },
        "EnabledFlag":{
            "title":"Redo Activity",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity group line is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"The due date duration.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorActivityGroups-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity group description.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "ActivityGroupLine":{
            "title":"Activity Group Lines",
            "type":"array",
            "description":"The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.",
            "items":{
                "$ref":"#/components/schemas/publicSectorActivityGroups-ActivityGroupLine-item-response"
            }
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering.",
            "nullable":false,
            "default":"PZ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivityGroupName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity group name.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorActivityGroups-ActivityGroupLine-item-response

{
    "title":"Activity Group Lines",
    "type":"array",
    "description":"The activity group lines resource is used to create, update, and delete an activity group line associated with a planning and zoning application.",
    "items":{
        "$ref":"#/components/schemas/publicSectorActivityGroups-ActivityGroupLine-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorActivityGroups-ActivityGroupLine-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TranType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type of the event trigger.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "ActivityPriority":{
            "type":"integer",
            "description":"The priority of the activity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ActivityName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group line.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "DuedateBasis":{
            "title":"Base Date",
            "maxLength":30,
            "type":"string",
            "description":"The base date used for due date calculation.",
            "nullable":false,
            "x-queryable":true
        },
        "ResubmitFlag":{
            "title":"Allow Resubmission",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity can be submitted. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityType":{
            "maxLength":30,
            "type":"string",
            "description":"The activity type associated with the group line.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "title":"Activity Group ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group associated with the group line.",
            "nullable":false,
            "x-queryable":true
        },
        "ExclDueDateCalc":{
            "maxLength":30,
            "type":"string",
            "description":"This indicates how the due date calculation will be carried out whether to exclude weekends and holidays.",
            "nullable":false,
            "default":"ORA_ACT_NA",
            "x-queryable":true
        },
        "LeadLagIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the due date is before or after the base date. Valid values are Days before base date and Days after base date.",
            "nullable":false,
            "x-queryable":true
        },
        "RedoFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N.",
            "nullable":false,
            "x-queryable":true
        },
        "DurationUom":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure for due date duration.",
            "nullable":true,
            "x-queryable":true
        },
        "DueDateAdjust":{
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"ORA_ACT_NA",
            "x-queryable":true
        },
        "TranStatus":{
            "maxLength":500,
            "type":"string",
            "description":"The transaction status associated with the activity.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Redo Activity",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity group line is enabled for use. Valid values are Y for enabled activity and N for disabled activity.",
            "nullable":true,
            "x-queryable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"The due date duration.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ActivityGroupLine

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/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.

Back to Top