Jump to

• Request
• Response

Update an activity log

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs/{ActivityLogKey}

Request

Path Parameters

• ActivityLogKey(required): integer(int64)
  The activity log key.

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.

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

• ActivityStatus: string
  Maximum Length: 30

  Default Value: Pending

  The status of the activity.
• ActualCompletionDate: string (date)
  The date when the activity is completed.
• AssignedTo: string
  Title: Assigned To

  Maximum Length: 240

  The activity primary assignment.
• BaseDate: string (date)
  Title: Base Date

  The activity base date.
• CurrentRowFlag: boolean
  Title: Current

  Maximum Length: 1

  Indicates whether the row is the current row.
• 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.
• DuedateDuration: integer (int32)
  The duration of the due date.
• 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 basis date. Valid values are Days Before and Days After.
• ObjectVersionNumber: integer (int32)
  The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OccuranceCount: integer (int32)
  The activity occurence count.
• OriginalBaseDate: string (date)
  The activity original base date.
• PlannedDueDate: string (date)
  Title: Due Date

  The activity planned due date.
• RedoFlag: string
  Maximum Length: 1

  Indicates whether an activity retrigger is required. The valid values are Y and N.
• ResubmitFlag: string
  Maximum Length: 1

  Indicates whether the activity is allowed to be resubmitted. The valid values are Y and N.
• ResubmittedFlag: boolean
  Title: Resubmitted

  Maximum Length: 1

  Indicates whether the activity was resubmitted. The default value is false.
• SystemStatus: string
  Maximum Length: 15

  Default Value: ORA_PND

  The system status.
• TranStatus: string
  Maximum Length: 500

  The transaction status associated with the activity.
• UpdatedByUser: string
  Title: Updated By

  Maximum Length: 64

  The user who last updated the activity.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The system status.",
            "nullable":false,
            "default":"ORA_PND",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActivityStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the activity.",
            "nullable":false,
            "default":"Pending",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdatedByUser":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the activity.",
            "nullable":true
        },
        "OriginalBaseDate":{
            "type":"string",
            "description":"The activity original base date.",
            "format":"date",
            "nullable":true
        },
        "ResubmitFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the activity is allowed to be resubmitted. The valid values are Y and N.",
            "nullable":true
        },
        "BaseDate":{
            "title":"Base Date",
            "type":"string",
            "description":"The activity base date.",
            "format":"date",
            "nullable":true
        },
        "OccuranceCount":{
            "type":"integer",
            "description":"The activity occurence count.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            }
        },
        "CurrentRowFlag":{
            "title":"Current",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the row is the current row.",
            "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"
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":240,
            "type":"string",
            "description":"The activity primary assignment.",
            "nullable":true
        },
        "LeadLagIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the due date is before or after the basis date. Valid values are Days Before and Days After.",
            "nullable":true
        },
        "PlannedDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The activity planned due date.",
            "format":"date",
            "nullable":false
        },
        "RedoFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "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":"The transaction status associated with the activity.",
            "nullable":true
        },
        "ResubmittedFlag":{
            "title":"Resubmitted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity was resubmitted. The default value is false.",
            "nullable":false
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"The date when the activity is completed.",
            "format":"date",
            "nullable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"The duration of the due date.",
            "format":"int32",
            "nullable":true,
            "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 : publicSectorActivityLogs-item-response

Type: object

Show Source

• ActivityGroupId: string
  Title: Activity Group ID

  Maximum Length: 30

  The unique identifier for the activity group.
• ActivityId: string
  Title: Activity ID

  Maximum Length: 50

  The unique identifier for the activity.
• ActivityLogId: string
  Maximum Length: 65

  Default Value: DEFAULT

  The unique identifier for the activity log ID.
• ActivityLogKey: integer (int64)
  Title: Activity Log

  The activity log key.
• ActivityName: string
  Title: Activity

  Read Only: true

  Maximum Length: 250

  The activity name.
• ActivityStatus: string
  Maximum Length: 30

  Default Value: Pending

  The status of the activity.
• ActualCompletionDate: string (date)
  The date when the activity is completed.
• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the agency associated with the activity.
• AssignedTo: string
  Title: Assigned To

  Maximum Length: 240

  The activity primary assignment.
• BaseDate: string (date)
  Title: Base Date

  The activity base date.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the activity.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the activity was created.
• CurrentRowFlag: boolean
  Title: Current

  Maximum Length: 1

  Indicates whether the row is the current row.
• 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

  The base date field used to calculate the activity due date.
• DuedateDuration: integer (int32)
  The duration of the due date.
• 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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the activity was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the activity.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the activity.
• LeadLagIndicator: string
  Maximum Length: 30

  Indicates whether the due date is before or after the basis date. Valid values are Days Before and Days After.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Meaning: string
  Read Only: true

  Maximum Length: 80

  The description of the base date.
• ObjectVersionNumber: integer (int32)
  The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• OccuranceCount: integer (int32)
  The activity occurence count.
• OriginalBaseDate: string (date)
  The activity original base date.
• PlannedDueDate: string (date)
  Title: Due Date

  The activity planned due date.
• RecordId: string
  Maximum Length: 50

  The unique identifier of the record.
• RecordKey: integer (int64)
  The record key.
• RedoFlag: string
  Maximum Length: 1

  Indicates whether an activity retrigger is required. The valid values are Y and N.
• ResubmitFlag: string
  Maximum Length: 1

  Indicates whether the activity is allowed to be resubmitted. The valid values are Y and N.
• ResubmittedFlag: boolean
  Title: Resubmitted

  Maximum Length: 1

  Indicates whether the activity was resubmitted. The default value is false.
• SystemStatus: string
  Maximum Length: 15

  Default Value: ORA_PND

  The system status.
• TransactionReferenceId: string
  Maximum Length: 50

  The transaction reference ID.
• TransactionReferenceKey: integer (int64)
  Title: Source Reference

  The transaction reference key.
• TranStatus: string
  Maximum Length: 500

  The transaction status associated with the activity.
• TranType: string
  Title: Transaction Type

  Maximum Length: 30

  The transaction type of the event trigger.
• UpdatedByUser: string
  Title: Updated By

  Maximum Length: 64

  The user who last updated the activity.

{
    "type":"object",
    "properties":{
        "ActivityLogKey":{
            "title":"Activity Log",
            "type":"integer",
            "description":"The activity log key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TranType":{
            "title":"Transaction Type",
            "maxLength":30,
            "type":"string",
            "description":"The transaction type of the event trigger.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the activity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the activity.",
            "nullable":false,
            "default":"Pending",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalBaseDate":{
            "type":"string",
            "description":"The activity original base date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityName":{
            "title":"Activity",
            "maxLength":250,
            "type":"string",
            "description":"The activity name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the activity.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The record key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "BaseDate":{
            "title":"Base Date",
            "type":"string",
            "description":"The activity base date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionReferenceKey":{
            "title":"Source Reference",
            "type":"integer",
            "description":"The transaction reference key.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OccuranceCount":{
            "type":"integer",
            "description":"The activity occurence count.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "PlannedDueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The activity planned due date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TranStatus":{
            "maxLength":500,
            "type":"string",
            "description":"The transaction status associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the record.",
            "nullable":false,
            "x-queryable":true
        },
        "ResubmittedFlag":{
            "title":"Resubmitted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity was resubmitted. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "type":"string",
            "description":"The date when the activity is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityLogId":{
            "maxLength":65,
            "type":"string",
            "description":"The unique identifier for the activity log ID.",
            "nullable":false,
            "default":"DEFAULT",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The system status.",
            "nullable":false,
            "default":"ORA_PND",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UpdatedByUser":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DuedateBasis":{
            "title":"Base Date",
            "maxLength":30,
            "type":"string",
            "description":"The base date field used to calculate the activity due date.",
            "nullable":false,
            "x-queryable":true
        },
        "ResubmitFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the activity is allowed to be resubmitted. The valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentRowFlag":{
            "title":"Current",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the row is the current row.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "title":"Activity Group ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the activity group.",
            "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
        },
        "AssignedTo":{
            "title":"Assigned To",
            "maxLength":240,
            "type":"string",
            "description":"The activity primary assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadLagIndicator":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the due date is before or after the basis date. Valid values are Days Before and Days After.",
            "nullable":true,
            "x-queryable":true
        },
        "RedoFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether an activity retrigger is required. The valid values are Y and N.",
            "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
        },
        "TransactionReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The transaction reference ID.",
            "nullable":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The description of the base date.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the activity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DuedateDuration":{
            "type":"integer",
            "description":"The duration of the due date.",
            "format":"int32",
            "nullable":true,
            "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