Jump to

• Request
• Response

Create an activity group

post

/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorActivityGroups-item

Type: object

Show Source

• 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

{
    "properties":{
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group."
        },
        "ActivityGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorActivityGroups-ActivityGroupLine-item"
            },
            "type":"array",
            "description":"The activity groups resource is used to create, update, and delete an activity group associated with a planning and zoning application.",
            "title":"Activity Group Lines"
        },
        "ActivityGroupName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity group name."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group."
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity group description."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorActivityGroups-ActivityGroupLine-item

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorActivityGroups-ActivityGroupLine-item

Type: object

Show Source

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

{
    "properties":{
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group associated with the group line.",
            "title":"Activity Group ID"
        },
        "ActivityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the activity.",
            "title":"Activity ID"
        },
        "ActivityName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity name."
        },
        "ActivityPriority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority of the activity."
        },
        "ActivityType":{
            "maxLength":30,
            "type":"string",
            "description":"The activity type associated with the group line."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group line."
        },
        "DuedateBasis":{
            "maxLength":30,
            "type":"string",
            "description":"The base date used for due date calculation.",
            "title":"Base Date"
        },
        "DuedateDuration":{
            "format":"int32",
            "type":"integer",
            "description":"The due date duration."
        },
        "DurationUom":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure for due date duration."
        },
        "EnabledFlag":{
            "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.",
            "title":"Redo Activity"
        },
        "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."
        },
        "RedoFlag":{
            "type":"boolean",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N."
        },
        "ResubmitFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity can be submitted. The default value is false.",
            "title":"Allow Resubmission"
        },
        "TranStatus":{
            "maxLength":500,
            "type":"string",
            "description":"The transaction status associated with the activity."
        },
        "TranType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type of the event trigger."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorActivityGroups-item

Type: object

Show Source

• 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

{
    "properties":{
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group."
        },
        "ActivityGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorActivityGroups-ActivityGroupLine-item"
            },
            "type":"array",
            "description":"The activity groups resource is used to create, update, and delete an activity group associated with a planning and zoning application.",
            "title":"Activity Group Lines"
        },
        "ActivityGroupName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity group name."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group."
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity group description."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity group is enabled for use. Valid values are Y for enabled activity and N for disabled activity."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorActivityGroups-ActivityGroupLine-item

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorActivityGroups-ActivityGroupLine-item

Type: object

Show Source

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

{
    "properties":{
        "ActivityGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group associated with the group line.",
            "title":"Activity Group ID"
        },
        "ActivityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the activity.",
            "title":"Activity ID"
        },
        "ActivityName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity name."
        },
        "ActivityPriority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority of the activity."
        },
        "ActivityType":{
            "maxLength":30,
            "type":"string",
            "description":"The activity type associated with the group line."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity group line."
        },
        "DuedateBasis":{
            "maxLength":30,
            "type":"string",
            "description":"The base date used for due date calculation.",
            "title":"Base Date"
        },
        "DuedateDuration":{
            "format":"int32",
            "type":"integer",
            "description":"The due date duration."
        },
        "DurationUom":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure for due date duration."
        },
        "EnabledFlag":{
            "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.",
            "title":"Redo Activity"
        },
        "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."
        },
        "RedoFlag":{
            "type":"boolean",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N."
        },
        "ResubmitFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity can be submitted. The default value is false.",
            "title":"Allow Resubmission"
        },
        "TranStatus":{
            "maxLength":500,
            "type":"string",
            "description":"The transaction status associated with the activity."
        },
        "TranType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type of the event trigger."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top