Jump to

• Request
• Response
• Examples

Update an action plan action

patch

/crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}

Request

Path Parameters

• ActionPlanActionId(required): integer(int64)
  The unique identifier of the action in an action plan.
• ActionPlanId(required): integer(int64)
  The unique identifier of the action plan.

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• ActionId: integer (int64)
  Title: Action ID

  The unique identifier of the action.
• ActionNumber: string
  Title: Action Number

  The reference number of the action in an action plan.
• actionPlanActionRelation: array Action Plan Action Relations
  Title: Action Plan Action Relations

  The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.
• ActionPlanId: integer (int64)
  Title: Action Plan ID

  The unique identifier of the action plan.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action in an action plan is deleted. The default value is false.
• EndDate: string (date-time)
  Title: End Date

  The date when an action in the action plan ends.
• ExpectedCompletionDate: string (date-time)
  Title: Expected Completion Date

  The date when the action in an action plan is to be completed.
• ExpectedStartDate: string (date-time)
  Title: Expected Start Date

  The date when an action in the action plan is expected to start.
• LeadTime: integer (int64)
  Title: Duration

  The estimated time required to complete the action.
• LeadTimeUnit: string
  Title: Duration Unit

  Maximum Length: 30

  The unit of measurement of the lead time, such as minutes, hours, or days.
• LeadTimeUnitMeaning: string
  Title: Lead Time Unit Value

  Maximum Length: 255

  The display value corresponding to the lead time unit lookup code for the action plan action.
• ObjectEntityNameMeaning: string
  Title: Object Entity Name Value

  Maximum Length: 255

  The display value corresponding to the object entity name lookup code for the action plan action.
• ObjectEntityTypeMeaning: string
  Title: Object Entity Type Value

  Maximum Length: 255

  The display value corresponding to the object entity type lookup code for the action plan action.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object associated with the action.
• ObjectReferenceNumber: string
  Title: Object Reference Number

  Maximum Length: 100

  The reference number of the object associated with the action.
• OrderNumber: integer (int64)
  Title: Step

  The order of the action in an action plan.
• ProcessInstanceId: string
  Title: Process Instance ID

  Maximum Length: 500

  Indicates the process instance identifier of an external process.
• ProcessStatus: string
  Title: Process Status

  Maximum Length: 100

  The status of the external process.
• SkipFlag: boolean
  Title: Skip

  Maximum Length: 1

  Default Value: false

  Indicates whether the action for the action plan can be skipped.
• StartDate: string (date-time)
  Title: Start Date

  The date when an action in the action plan begins.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.
• StatusCdMeaning: string
  Title: Status Value

  Maximum Length: 255

  The display value corresponding to the status lookup code for the action plan action.
• StatusDetails: string
  Title: Status Details

  Maximum Length: 1000

  The details of the status of an action in an action plan.
• VisibilityCdMeaning: string
  Title: Visibility Value

  Maximum Length: 255

  The display value corresponding to the visibility lookup code for the action plan action.
• WorkflowActionId: integer (int64)
  Title: Workflow Action ID

  The unique identifier of the action for the workflow.
• WorkflowId: integer (int64)
  Title: Workflow ID

  The unique identifier of the workflow.

{
    "type":"object",
    "properties":{
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action in an action plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an action in the action plan ends.",
            "format":"date-time",
            "nullable":true
        },
        "ExpectedCompletionDate":{
            "title":"Expected Completion Date",
            "type":"string",
            "description":"The date when the action in an action plan is to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "ExpectedStartDate":{
            "title":"Expected Start Date",
            "type":"string",
            "description":"The date when an action in the action plan is expected to start.",
            "format":"date-time",
            "nullable":true
        },
        "LeadTime":{
            "title":"Duration",
            "type":"integer",
            "description":"The estimated time required to complete the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LeadTimeUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the lead time, such as minutes, hours, or days.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LeadTimeUnitMeaning":{
            "title":"Lead Time Unit Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the lead time unit lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LeadTimeUnit"
                ]
            }
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            }
        },
        "ObjectEntityTypeMeaning":{
            "title":"Object Entity Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity type lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityType"
                ]
            }
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectReferenceNumber":{
            "title":"Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true
        },
        "OrderNumber":{
            "title":"Step",
            "type":"integer",
            "description":"The order of the action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"Indicates the process instance identifier of an external process.",
            "nullable":true
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true
        },
        "SkipFlag":{
            "title":"Skip",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action for the action plan can be skipped.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an action in the action plan begins.",
            "format":"date-time",
            "nullable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            }
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the status of an action in an action plan.",
            "nullable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            }
        },
        "WorkflowActionId":{
            "title":"Workflow Action ID",
            "type":"integer",
            "description":"The unique identifier of the action for the workflow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkflowId":{
            "title":"Workflow ID",
            "type":"integer",
            "description":"The unique identifier of the workflow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "actionPlanActionRelation":{
            "title":"Action Plan Action Relations",
            "type":"array",
            "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-patch-request"
            }
        }
    }
}

Nested Schema : Action Plan Action Relations

Type: array

Title: Action Plan Action Relations

The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.

Show Source

• Array of: object schema

{
    "title":"Action Plan Action Relations",
    "type":"array",
    "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ActionPlanActionId: integer (int64)
  Title: Action Plan Action ID

  The unique identifier of the action in an action plan.
• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  Default Value: ORA_SVC_COMPLETED

  The code indicating the status of the dependency condition of the action relation.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action dependency is deleted. The default value is false.
• DepActionPlanActionId: integer (int64)
  Title: Dependent Action Plan Action ID

  The unique identifier of the dependent action in an action plan.

{
    "type":"object",
    "properties":{
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the dependency condition of the action relation.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED"
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DepActionPlanActionId":{
            "title":"Dependent Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : actionplans-actionPlanAction-item-response

Type: object

Show Source

• ActionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of an action in an action plan.
• ActionId: integer (int64)
  Title: Action ID

  The unique identifier of the action.
• ActionName: string
  Title: Action

  Read Only: true

  Maximum Length: 400

  The name of the action.
• ActionNumber: string
  Title: Action Number

  The reference number of the action in an action plan.
• ActionPlanActionId: integer (int64)
  Title: Action Plan Action ID

  Read Only: true

  The unique identifier of the action in an action plan.
• ActionPlanActionNumber: string
  Title: Action Plan Action Number

  Maximum Length: 30

  The alternate unique identifier of an action plan action.
• actionPlanActionRelation: array Action Plan Action Relations
  Title: Action Plan Action Relations

  The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.
• ActionPlanId: integer (int64)
  Title: Action Plan ID

  The unique identifier of the action plan.
• ActionPlanNumber: string
  Title: Action Plan Number

  Maximum Length: 30

  The action plan reference number.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the action in an action plan.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the action was created in an action plan.
• DelayedFlag: boolean
  Read Only: true

  Indicates whether the action in an action plan is delayed.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action in an action plan is deleted. The default value is false.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the action in an action plan can be deleted.
• EndDate: string (date-time)
  Title: End Date

  The date when an action in the action plan ends.
• EndDateReadOnlyFlag: boolean
  Read Only: true

  Indicates whether the end date should be read only.
• ExpectedCompletionDate: string (date-time)
  Title: Expected Completion Date

  The date when the action in an action plan is to be completed.
• ExpectedStartDate: string (date-time)
  Title: Expected Start Date

  The date when an action in the action plan is expected to start.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the action was last updated in an action plan.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the action in an action plan.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the action in an action plan.
• LeadTime: integer (int64)
  Title: Duration

  The estimated time required to complete the action.
• LeadTimeUnit: string
  Title: Duration Unit

  Maximum Length: 30

  The unit of measurement of the lead time, such as minutes, hours, or days.
• LeadTimeUnitMeaning: string
  Title: Lead Time Unit Value

  Maximum Length: 255

  The display value corresponding to the lead time unit lookup code for the action plan action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Default Value: true

  Indicates whether the action in an action plan is mandatory. The default value is false.
• ObjectEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 400

  The name of the parent entity object on which the action is based.
• ObjectEntityNameMeaning: string
  Title: Object Entity Name Value

  Maximum Length: 255

  The display value corresponding to the object entity name lookup code for the action plan action.
• ObjectEntitySubtype: string
  Title: Object Entity Subtype

  Read Only: true

  Maximum Length: 400

  Indicates the object entity subtype of the action in the action plan.
• ObjectEntityType: string
  Title: Type

  Read Only: true

  Maximum Length: 400

  The type of the parent entity object on which the action is based.
• ObjectEntityTypeMeaning: string
  Title: Object Entity Type Value

  Maximum Length: 255

  The display value corresponding to the object entity type lookup code for the action plan action.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object associated with the action.
• ObjectReferenceNumber: string
  Title: Object Reference Number

  Maximum Length: 100

  The reference number of the object associated with the action.
• OrderNumber: integer (int64)
  Title: Step

  The order of the action in an action plan.
• OwnerName: string
  Title: Owner

  Read Only: true

  The name of the owner of the action.
• Prerequisites: string
  Title: Prerequisites

  Read Only: true

  The prerequisite steps required to initiate the action.
• ProcessInstanceId: string
  Title: Process Instance ID

  Maximum Length: 500

  Indicates the process instance identifier of an external process.
• ProcessStatus: string
  Title: Process Status

  Maximum Length: 100

  The status of the external process.
• SkipFlag: boolean
  Title: Skip

  Maximum Length: 1

  Default Value: false

  Indicates whether the action for the action plan can be skipped.
• StartDate: string (date-time)
  Title: Start Date

  The date when an action in the action plan begins.
• StatusCd: string
  Title: Status

  Maximum Length: 30

  The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.
• StatusCdMeaning: string
  Title: Status Value

  Maximum Length: 255

  The display value corresponding to the status lookup code for the action plan action.
• StatusDetails: string
  Title: Status Details

  Maximum Length: 1000

  The details of the status of an action in an action plan.
• TemplateId: integer (int64)
  Title: Template ID

  The unique identifier of the action plan template from which the action is created.
• TemplateNumber: string
  Title: Template Number

  Maximum Length: 30

  The reference number of the action plan template.
• TemplateTemplateId: integer (int64)
  Title: Template ID

  Read Only: true

  The unique identifier of a template.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the action in an action plan can be updated.
• VisibilityCd: string
  Title: Visibility

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SVC_NOT_PUBLISHED

  The code indicating the visibility level of the action. A list of valid values is defined in the lookup ORA_SVC_AP_VISIBILITY_CD.
• VisibilityCdMeaning: string
  Title: Visibility Value

  Maximum Length: 255

  The display value corresponding to the visibility lookup code for the action plan action.
• WorkflowActionId: integer (int64)
  Title: Workflow Action ID

  The unique identifier of the action for the workflow.
• WorkflowId: integer (int64)
  Title: Workflow ID

  The unique identifier of the workflow.

{
    "type":"object",
    "properties":{
        "ActionDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an action in an action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionName":{
            "title":"Action",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action in an action plan.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanActionNumber":{
            "title":"Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of an action plan action.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanNumber":{
            "title":"Action Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action in an action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action was created in an action plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayedFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is delayed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EndDate",
                    "StartDate",
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an action in the action plan ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateReadOnlyFlag":{
            "type":"boolean",
            "description":"Indicates whether the end date should be read only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "title":"Expected Completion Date",
            "type":"string",
            "description":"The date when the action in an action plan is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedStartDate":{
            "title":"Expected Start Date",
            "type":"string",
            "description":"The date when an action in the action plan is expected to start.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action was last updated in an action plan.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action in an action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action in an action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadTime":{
            "title":"Duration",
            "type":"integer",
            "description":"The estimated time required to complete the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadTimeUnit":{
            "title":"Duration Unit",
            "maxLength":30,
            "type":"string",
            "description":"The unit of measurement of the lead time, such as minutes, hours, or days.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeadTimeUnitMeaning":{
            "title":"Lead Time Unit Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the lead time unit lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LeadTimeUnit"
                ]
            },
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action in an action plan is mandatory. The default value is false.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the parent entity object on which the action is based.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectEntityNameMeaning":{
            "title":"Object Entity Name Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity name lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "ObjectEntitySubtype":{
            "title":"Object Entity Subtype",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity subtype of the action in the action plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectEntityType":{
            "title":"Type",
            "maxLength":400,
            "type":"string",
            "description":"The type of the parent entity object on which the action is based.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectEntityTypeMeaning":{
            "title":"Object Entity Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the object entity type lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityType"
                ]
            },
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectReferenceNumber":{
            "title":"Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Step",
            "type":"integer",
            "description":"The order of the action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "type":"string",
            "description":"The name of the owner of the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Prerequisites":{
            "title":"Prerequisites",
            "type":"string",
            "description":"The prerequisite steps required to initiate the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"Indicates the process instance identifier of an external process.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "title":"Process Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the external process.",
            "nullable":true,
            "x-queryable":true
        },
        "SkipFlag":{
            "title":"Skip",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action for the action plan can be skipped.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an action in the action plan begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCdMeaning":{
            "title":"Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the status of an action in an action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template from which the action is created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateNumber":{
            "title":"Template Number",
            "maxLength":30,
            "type":"string",
            "description":"The reference number of the action plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateTemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of a template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action in an action plan can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "VisibilityCd":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the visibility level of the action. A list of valid values is defined in the lookup ORA_SVC_AP_VISIBILITY_CD.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_NOT_PUBLISHED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VisibilityCdMeaning":{
            "title":"Visibility Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the visibility lookup code for the action plan action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "VisibilityCd"
                ]
            },
            "x-queryable":true
        },
        "WorkflowActionId":{
            "title":"Workflow Action ID",
            "type":"integer",
            "description":"The unique identifier of the action for the workflow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkflowId":{
            "title":"Workflow ID",
            "type":"integer",
            "description":"The unique identifier of the workflow.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "actionPlanActionRelation":{
            "title":"Action Plan Action Relations",
            "type":"array",
            "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Action Plan Action Relations

Type: array

Title: Action Plan Action Relations

The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.

Show Source

• Array of: object actionplans-actionPlanAction-actionPlanActionRelation-item-response

{
    "title":"Action Plan Action Relations",
    "type":"array",
    "description":"The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-actionPlanActionRelation-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 : actionplans-actionPlanAction-actionPlanActionRelation-item-response

Type: object

Show Source

• ActionPlanActionId: integer (int64)
  Title: Action Plan Action ID

  The unique identifier of the action in an action plan.
• ActionPlanActionNumber: string
  Title: Action Plan Action Number

  Maximum Length: 30

  The action plan reference number.
• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  Default Value: ORA_SVC_COMPLETED

  The code indicating the status of the dependency condition of the action relation.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the dependencies of an action.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the action dependency was created.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action dependency is deleted. The default value is false.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the action dependency can be deleted.
• DepActionPlanActionId: integer (int64)
  Title: Dependent Action Plan Action ID

  The unique identifier of the dependent action in an action plan.
• DepActionPlanActionNumber: string
  Title: Dependent Action Plan Action Number

  Maximum Length: 30

  The dependent action plan reference number.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the action dependency was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the dependencies of action.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the dependencies of action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RelationId: integer (int64)
  Title: Relation ID

  Read Only: true

  The unique identifier of the relation between actions in an action plan.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the action dependency can be updated.

{
    "type":"object",
    "properties":{
        "ActionPlanActionId":{
            "title":"Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the action in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanActionNumber":{
            "title":"Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the dependency condition of the action relation.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the dependencies of an action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action dependency was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action dependency can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DepActionPlanActionId":{
            "title":"Dependent Action Plan Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DepActionPlanActionNumber":{
            "title":"Dependent Action Plan Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The dependent action plan reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action dependency was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the dependencies of action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dependencies of action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationId":{
            "title":"Relation ID",
            "type":"integer",
            "description":"The unique identifier of the relation between actions in an action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action dependency can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

ActionVisibilityCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_VISIBILITY_CD

The list of values indicating the visibility of the action in an action plan.

The following properties are defined on the LOV link relation:

• Source Attribute: VisibilityCd; Target Attribute: LookupCode
• Display Attribute: Meaning

LeadTimeUnitLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_LEAD_TIME_UNIT

The list of values indicating the unit of measurement for the time required to complete an action.

The following properties are defined on the LOV link relation:

• Source Attribute: LeadTimeUnit; Target Attribute: LookupCode
• Display Attribute: Meaning

StatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD

The list of values indicating the status of the action in an action plan.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCd; Target Attribute: LookupCode
• Display Attribute: Meaning

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating whether an action in an action plan is skipped.

The following properties are defined on the LOV link relation:

• Source Attribute: SkipFlag; Target Attribute: LookupCode
• Display Attribute: LookupCode

actionPlanActionRelation

Operation: /crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction/{ActionPlanActionId}/child/actionPlanActionRelation

Parameters:

• ActionPlanActionId: $request.path.ActionPlanActionId
• ActionPlanId: $request.path.ActionPlanId

The action plan action relations resource is used to view, create, update, and delete the relations between the actions in an action plan. An action relation may define the sequence in which the actions are to be carried out.

Back to Top

Examples

The following example shows how to update an action in an action plan by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans/300100117534967/child/actionPlanAction/300100118919336

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"StatusDetails": "Not started"
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"ActionId": 300100117527290,
"ActionPlanActionId": 300100118919336,
"ActionPlanId": 300100117534967,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T14:15:59+00:00",
"DelayedFlag": false,
"DeletedFlag": false,
"EndDate": null,
"ExpectedCompletionDate": null,
"ExpectedStartDate": null,
"LastUpdateDate": "2017-09-27T14:29:53+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"LeadTime": null,
"LeadTimeUnit": null,
"MandatoryFlag": true,
"ObjectId": null,
"ObjectReferenceNumber": null,
"OrderNumber": 1,
"StartDate": null,
"StatusCd": "ORA_SVC_NOT_STARTED",
"StatusDetails": "Not started",
"TemplateId": null,
"OwnerName": null,
"Prerequisites": null,
"ObjectEntityName": "Activity",
"ObjectEntityType": "Appointment",
"VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE",
"ActionName": "action149_1",
"UpdateFlag": true,
"DeleteFlag": true,
"ActionNumber": "ACT0000043279",
"ActionDescription": null,
"EndDateReadOnlyFlag": false,
"DclActionPlan_Id_c": null,
"DclActionPlan_c": null,
"links": [
  ...
 ]
}

Back to Top