Jump to

• Request
• Response

Get an activity group

get

/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}

Request

Path Parameters

• publicSectorActivityGroupsUniqID(required): string
  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 fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

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