Jump to

• Request
• Response

Create all activity group lines

post

/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroupLines

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 ()

Root Schema : schema

Type: object

Show Source

• ActivityGroupId: string
  Title: Activity Group ID

  Maximum Length: 30

  This column is used to indicate activity group id.
• ActivityId: string
  Title: Activity ID

  Maximum Length: 50

  This column is used to indicate activity id.
• ActivityPriority: integer (int32)
  This column is used to indicate activity priority.
• ActivityType: string
  Maximum Length: 30

  This column is used to indicate activity type.
• AgencyId: integer (int32)
  Default Value: 1

  This column is used to indicate agency id.
• DueDateAdjust: string
  Maximum Length: 30

  Default Value: ORA_ACT_NA

  This indicates whether the due date calculation should be adjusted to the prior or the next day based on if the due date falls on a weekend or holiday.
• DuedateBasis: string
  Title: Base Date

  Maximum Length: 30

  This column is used to indicate the base date field used for due date calculation.
• DuedateDuration: integer (int32)
  This column is used to indicate due date duration.
• DurationUom: string
  Maximum Length: 30

  This column is used to indicate the activity type.
• EnabledFlag: boolean
  Title: Redo Activity

  Maximum Length: 1

  This column is used to indicate that the configuration is enabled.
• 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

  This column is used to indicate the due date is before or after the basis date.
• RedoFlag: boolean
  Maximum Length: 1

  This column is used to indicate if the activity retrigger is required.
• ResubmitFlag: boolean
  Title: Allow Resubmission

  Maximum Length: 1

  This column is used to indicate if the activity resubmittal is allowed.
• TranStatus: string
  Maximum Length: 500

  Default Value:

  This column is used to indicate the transaction status.
• TranType: string
  Maximum Length: 30

  Default Value:

  This column is used to indicate the transaction type of the event trigger.

{
    "type":"object",
    "properties":{
        "TranType":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the transaction type of the event trigger.",
            "nullable":false,
            "default":" "
        },
        "ActivityPriority":{
            "type":"integer",
            "description":"This column is used to indicate activity priority.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            }
        },
        "AgencyId":{
            "type":"integer",
            "description":"This column is used to indicate agency id.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "DuedateBasis":{
            "title":"Base Date",
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the base date field used for due date calculation.",
            "nullable":false
        },
        "ResubmitFlag":{
            "title":"Allow Resubmission",
            "maxLength":"1",
            "type":"boolean",
            "description":"This column is used to indicate if the activity resubmittal is allowed.",
            "nullable":false
        },
        "ActivityId":{
            "title":"Activity ID",
            "maxLength":"50",
            "type":"string",
            "description":"This column is used to indicate activity id.",
            "nullable":false
        },
        "ActivityType":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate activity type.",
            "nullable":false
        },
        "ActivityGroupId":{
            "title":"Activity Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate activity group id.",
            "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":"This column is used to indicate the due date is before or after the basis date.",
            "nullable":false
        },
        "RedoFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"This column is used to indicate if the activity retrigger is required.",
            "nullable":false
        },
        "DurationUom":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the activity type.",
            "nullable":true
        },
        "DueDateAdjust":{
            "maxLength":"30",
            "type":"string",
            "description":"This indicates whether the due date calculation should be adjusted to the prior or the next day based on if the due date falls on a weekend or holiday.",
            "nullable":false,
            "default":"ORA_ACT_NA"
        },
        "TranStatus":{
            "maxLength":"500",
            "type":"string",
            "description":"This column is used to indicate the transaction status.",
            "nullable":false,
            "default":" "
        },
        "EnabledFlag":{
            "title":"Redo Activity",
            "maxLength":"1",
            "type":"boolean",
            "description":"This column is used to indicate that the configuration is enabled.",
            "nullable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"This column is used to indicate 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:
  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 : publicSectorActivityGroupLines-item-response

Type: object

Show Source

• ActivityGroupId: string
  Title: Activity Group ID

  Maximum Length: 30

  This column is used to indicate activity group id.
• ActivityId: string
  Title: Activity ID

  Maximum Length: 50

  This column is used to indicate activity id.
• ActivityName: string
  Read Only: true

  Maximum Length: 250

  This column is used to indicate the activity name.
• ActivityPriority: integer (int32)
  This column is used to indicate activity priority.
• ActivityType: string
  Maximum Length: 30

  This column is used to indicate activity type.
• AgencyId: integer (int32)
  Default Value: 1

  This column is used to indicate agency id.
• DueDateAdjust: string
  Maximum Length: 30

  Default Value: ORA_ACT_NA

  This indicates whether the due date calculation should be adjusted to the prior or the next day based on if the due date falls on a weekend or holiday.
• DuedateBasis: string
  Title: Base Date

  Maximum Length: 30

  This column is used to indicate the base date field used for due date calculation.
• DuedateDuration: integer (int32)
  This column is used to indicate due date duration.
• DurationUom: string
  Maximum Length: 30

  This column is used to indicate the activity type.
• EnabledFlag: boolean
  Title: Redo Activity

  Maximum Length: 1

  This column is used to indicate that the configuration is enabled.
• 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

  This column is used to indicate the due date is before or after the basis date.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RedoFlag: boolean
  Maximum Length: 1

  This column is used to indicate if the activity retrigger is required.
• ResubmitFlag: boolean
  Title: Allow Resubmission

  Maximum Length: 1

  This column is used to indicate if the activity resubmittal is allowed.
• TranStatus: string
  Maximum Length: 500

  Default Value:

  This column is used to indicate the transaction status.
• TranType: string
  Maximum Length: 30

  Default Value:

  This column is used to indicate the transaction type of the event trigger.

{
    "type":"object",
    "properties":{
        "TranType":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the transaction type of the event trigger.",
            "nullable":false,
            "default":" ",
            "x-queryable":true
        },
        "ActivityPriority":{
            "type":"integer",
            "description":"This column is used to indicate activity priority.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "ActivityName":{
            "maxLength":"250",
            "type":"string",
            "description":"This column is used to indicate the activity name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"This column is used to indicate agency id.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DuedateBasis":{
            "title":"Base Date",
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the base date field used for due date calculation.",
            "nullable":false,
            "x-queryable":true
        },
        "ResubmitFlag":{
            "title":"Allow Resubmission",
            "maxLength":"1",
            "type":"boolean",
            "description":"This column is used to indicate if the activity resubmittal is allowed.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "maxLength":"50",
            "type":"string",
            "description":"This column is used to indicate activity id.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityType":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate activity type.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "title":"Activity Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate activity group id.",
            "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":"This column is used to indicate the due date is before or after the basis date.",
            "nullable":false,
            "x-queryable":true
        },
        "RedoFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"This column is used to indicate if the activity retrigger is required.",
            "nullable":false,
            "x-queryable":true
        },
        "DurationUom":{
            "maxLength":"30",
            "type":"string",
            "description":"This column is used to indicate the activity type.",
            "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 the next day based on if the due date falls on a weekend or holiday.",
            "nullable":false,
            "default":"ORA_ACT_NA",
            "x-queryable":true
        },
        "TranStatus":{
            "maxLength":"500",
            "type":"string",
            "description":"This column is used to indicate the transaction status.",
            "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":"This column is used to indicate that the configuration is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"This column is used to indicate 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."
        }
    }
}

Back to Top