Create an activity log
post
/fscmRestApi/resources/11.13.18.05/publicSectorActivityLogs
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
Root Schema : schema
Type:
Show Source
object
-
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. -
ActivityStatus: string
Maximum Length:
30
Default Value:Pending
The status of the activity. -
ActualCompletionDate: string
(date)
The date when the activity is completed.
-
AdhocFlag: string
Maximum Length:
1
Default Value:N
This indicates whether the activity has been added by system trigger or by ad hoc activity. -
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. -
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. -
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. -
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.
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.
Root Schema : publicSectorActivityLogs-item-response
Type:
Show Source
object
-
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.
-
AdhocFlag: string
Maximum Length:
1
Default Value:N
This indicates whether the activity has been added by system trigger or by ad hoc activity. -
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.