Jump to

• Request
• Response

Update an activity group line

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivityGroups/{publicSectorActivityGroupsUniqID}/child/ActivityGroupLine/{ActivityGroupLineUniqID}

Request

Supported Media Types

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

Path Parameters

• ActivityGroupLineUniqID: integer
  This is the hash key of the attributes which make up the composite key--- ActivityGroupId, ActivityId, AgencyId, DuedateBasis, TranStatus and TranType ---for the Activity Group Lines resource and used to uniquely identify an instance of Activity Group Lines. The client should not generate the hash key value. Instead, the client should query on the Activity Group Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Group Lines.
  
  For example: ActivityGroupLine?q=ActivityGroupId=<value1>;ActivityId=<value2>;AgencyId=<value3>;DuedateBasis=<value4>;TranStatus=<value5>;TranType=<value6>
• publicSectorActivityGroupsUniqID: integer
  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>

Body ()

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

Root 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-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