Jump to

• Request
• Response
• Examples

Get all action plans

get

/crmRestApi/resources/11.13.18.05/actionplans

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ActionPlanNumberRowFinder: Finds an action plan with the specified primary key.
    Finder Variables:
    • ActionPlanNumber; string; The alternate unique identifier of an action plan.
  • PrimaryKey: Finds an action plan with the specified primary key.
    Finder Variables:
    • ActionPlanId; integer; The unique identifier of the action plan.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActionId; integer; The unique identifier of the action.
  • ActionObjectEntitySubtype; string; Indicates the object entity subtype of the action.
  • ActionObjectEntityType; string; Indicates the object entity type of the action.
  • ActionObjectId; integer; The unique object identifier associated with the action.
  • ActionObjectReferenceNumber; string; The reference number of the object associated with the action.
  • ActionPlanId; integer; The unique identifier of the action plan.
  • ActionPlanNumber; string; The alternate unique identifier of an action plan.
  • ActionPlanTypeCd; string; Lookup code that indicates the type of action plan, such as Template based Action Plan, or PCS process based Action Plan.
  • ActionPlanTypeCdMeaning; string; The display value corresponding to the action plan type lookup code for the action plan.
  • ActionStatusCd; string; The status of the action.
  • ActionStatusCdMeaning; string; The display value corresponding to the status lookup code for the action.
  • ActualCompletionDate; string; The date and time when the action plan was actually completed.
  • AdditionalInformation; string; The additional information about the action plan record.
  • CalendarId; integer; The unique identifier of the calendar associated with the action plan.
  • CreatedBy; string; The user who created the action plan.
  • CreationDate; string; The date and time when the action plan was created.
  • DeletedFlag; boolean; Indicates whether the action plan is deleted. The default value is false.
  • ExpectedCompletionDate; string; The date when the action plan is to be completed.
  • InitialCompletionDate; string; The initial date when the action plan was expected to be completed.
  • InitiateFlag; boolean; Indicates whether the action plan should initiated when it is created.
  • LastRefreshedDate; string; The date when the action plan status was last refreshed.
  • LastUpdateDate; string; The date and time when the action plan was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the action plan.
  • LastUpdatedBy; string; The user who last updated the action plan.
  • Name; string; The name of the user who last updated the action plan.
  • ObjectEntityName; string; The name of the parent entity object associated with the action plan.
  • ObjectEntityNameMeaning; string; The display value corresponding to the object entity name lookup code for the action plan.
  • ObjectId; integer; The unique identifier of the object associated with the action plan.
  • ObjectNumber; string; The object reference number of the action plan.
  • OrderNumber; integer; The order of the action plan in the list of action plans.
  • ProcessInstanceId; string; The process instance identifier from of an external process.
  • ProcessStatus; string; The status of the external process.
  • SchedulePuid; string; The public unique identifier of a standard coverage schedule.
  • StartDate; string; The date when the action plan starts.
  • Status; string; The status of the action plan, such as ORA_SVC_CREATE, ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED. The ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet started. The ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS. The ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status. The ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects. If there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object. The ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.
  • StatusCd; string; The code indicating the status of the action, such as ORA_SVC_CREATE, ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED. The ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet started. The ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS. The ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status. The ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects. If there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object. The ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.
  • StatusCdMeaning; string; The display value corresponding to the status lookup code for the action plan.
  • StatusDetails; string; The explanation of the error status of the action plan.
  • TemplateId; integer; The unique identifier of the action plan template from which the action plan is created.
  • TemplateNumber; string; The reference number of the action plan template.
  • WorkflowActionId; integer; The unique identifier of the action for the workflow.
  • WorkflowId; integer; The unique identifier of the workflow.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/actionplans-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object actionplans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/actionplans-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-item-response

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.
• ActionObjectEntitySubtype: string
  Title: Object Entity Subtype

  Read Only: true

  Maximum Length: 400

  Indicates the object entity subtype of the action.
• ActionObjectEntityType: string
  Title: Type

  Read Only: true

  Maximum Length: 400

  Indicates the object entity type of the action.
• ActionObjectId: integer (int64)
  Title: Action Object ID

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

  Maximum Length: 100

  The reference number of the object associated with the action.
• actionPlanAction: array Action Plan Actions
  Title: Action Plan Actions

  The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.
• ActionPlanId: integer (int64)
  Title: Action Plan ID

  Read Only: true

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

  Maximum Length: 30

  The alternate unique identifier of an action plan.
• ActionPlanTypeCd: string
  Title: Action Plan Type Code

  Maximum Length: 30

  Default Value: ORA_SVC_TEMPLATE

  Lookup code that indicates the type of action plan, such as Template based Action Plan, or PCS process based Action Plan.
• ActionPlanTypeCdMeaning: string
  Title: Action Plan Type Value

  Read Only: true

  Maximum Length: 255

  The display value corresponding to the action plan type lookup code for the action plan.
• ActionStatusCd: string
  Title: Action Status Code

  Maximum Length: 30

  The status of the action.
• ActionStatusCdMeaning: string
  Title: Action Status Code Meaning

  Maximum Length: 255

  The display value corresponding to the status lookup code for the action.
• ActualCompletionDate: string (date-time)
  Title: Actual Completion Date

  The date and time when the action plan was actually completed.
• AdditionalInformation: string
  Title: Additional Information

  Maximum Length: 2000

  The additional information about the action plan record.
• CalendarId: integer (int64)
  Title: Calendar ID

  The unique identifier of the calendar associated with the action plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Default Value: false

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

  Indicates whether the action plan can be deleted.
• ExpectedCompletionDate: string (date-time)
  Title: Projected Completion Date

  The date when the action plan is to be completed.
• InitialCompletionDate: string (date-time)
  Title: Initial Expected Completion Date

  The initial date when the action plan was expected to be completed.
• InitiateFlag: boolean
  Title: Auto Start

  Default Value: false

  Indicates whether the action plan should initiated when it is created.
• LastRefreshedDate: string (date-time)
  Title: Last Refreshed Date

  The date when the action plan status was last refreshed.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the 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 plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string (byte)
  Title: Message

  Indicates a message sent by the AI Agent.
• Name: string
  Title: Name

  Maximum Length: 400

  The name of the user who last updated the action plan.
• ObjectEntityName: string
  Title: Object Entity Name

  Maximum Length: 400

  The name of the parent entity object associated with the action plan.
• 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.
• ObjectId: integer (int64)
  Title: Object ID

  The unique identifier of the object associated with the action plan.
• ObjectNumber: string
  The object reference number of the action plan.
• OrderNumber: integer (int64)
  Title: Order Number

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

  Maximum Length: 500

  The process instance identifier from of an external process.
• ProcessStatus: string
  Title: Process Status

  Maximum Length: 100

  The status of the external process.
• SchedulePuid: string
  Title: Schedule PUID

  Read Only: true

  Maximum Length: 120

  The public unique identifier of a standard coverage schedule.
• StartDate: string (date-time)
  Title: Start Date

  The date when the action plan starts.
• Status: string
  Read Only: true

  The status of the action plan, such as ORA_SVC_CREATE, ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED. The ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet started. The ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS. The ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status. The ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects. If there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object. The ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.
• StatusCd: string
  Title: Status Code

  Maximum Length: 30

  The code indicating the status of the action, such as ORA_SVC_CREATE, ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED. The ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet started. The ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS. The ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status. The ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects. If there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object. The ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.
• StatusCdMeaning: string
  Title: Status Value

  Maximum Length: 255

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

  Maximum Length: 2000

  The explanation of the error status of the action plan.
• TemplateId: integer (int64)
  Title: Template ID

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

  Maximum Length: 30

  The reference number of the action plan template.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the action plan can be updated.
• 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":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "type":"string",
            "description":"The reference number of the action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActionObjectEntitySubtype":{
            "title":"Object Entity Subtype",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity subtype of the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionObjectEntityType":{
            "title":"Type",
            "maxLength":400,
            "type":"string",
            "description":"Indicates the object entity type of the action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionObjectId":{
            "title":"Action Object ID",
            "type":"integer",
            "description":"The unique object identifier associated with the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionObjectReferenceNumber":{
            "title":"Action Object Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"The reference number of the object associated with the action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionPlanId":{
            "title":"Action Plan ID",
            "type":"integer",
            "description":"The unique identifier of the action plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionPlanNumber":{
            "title":"Action Plan Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of an action plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionPlanTypeCd":{
            "title":"Action Plan Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Lookup code that indicates the type of action plan, such as Template based Action Plan, or PCS process based Action Plan.",
            "nullable":false,
            "default":"ORA_SVC_TEMPLATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionPlanTypeCdMeaning":{
            "title":"Action Plan Type Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action plan type lookup code for the action plan.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ActionPlanTypeCd"
                ]
            },
            "x-queryable":true
        },
        "ActionStatusCd":{
            "title":"Action Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the action.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Code Meaning",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the status lookup code for the action.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"The date and time when the action plan was actually completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AdditionalInformation":{
            "title":"Additional Information",
            "maxLength":2000,
            "type":"string",
            "description":"The additional information about the action plan record.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"The unique identifier of the calendar associated with the action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action plan was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpectedCompletionDate":{
            "title":"Projected Completion Date",
            "type":"string",
            "description":"The date when the action plan is to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InitialCompletionDate":{
            "title":"Initial Expected Completion Date",
            "type":"string",
            "description":"The initial date when the action plan was expected to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InitiateFlag":{
            "title":"Auto Start",
            "type":"boolean",
            "description":"Indicates whether the action plan should initiated when it is created.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastRefreshedDate":{
            "title":"Last Refreshed Date",
            "type":"string",
            "description":"The date when the action plan status was last refreshed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the action plan 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 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 plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "title":"Message",
            "type":"string",
            "description":"Indicates a message sent by the AI Agent.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the user who last updated the action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Object Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the parent entity object associated with the action plan.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"The unique identifier of the object associated with the action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectNumber":{
            "type":"string",
            "description":"The object reference number of the action plan.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Order Number",
            "type":"integer",
            "description":"The order of the action plan in the list of action plans.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessInstanceId":{
            "title":"Process Instance ID",
            "maxLength":500,
            "type":"string",
            "description":"The process instance identifier from 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
        },
        "SchedulePuid":{
            "title":"Schedule PUID",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of a standard coverage schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action plan starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"The status of the action plan, such as ORA_SVC_CREATE,  ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED.\nThe ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet\nstarted.\nThe ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS.\nThe ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status.\nThe ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects.\nIf there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object.\nThe ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action, such as ORA_SVC_CREATE,  ORA_SVC_IN_PROGRESS, ORA_SVC_COMPLETED, or ORA_SVC_ERROR. The ORA_SVC_CREATE status indicates that the required child records for the action plan based on its assigned template is created, and the status changes to ORA_SVC_CREATED.\nThe ORA_SVC_CREATED status indicates that all the child action plan actions are created but the overall plan is not yet\nstarted.\nThe ORA_SVC_INITIATE status indicates that the action plan is initiated, and if successful, the status is changed to ORA_SVC_IN_PROGRESS.\nThe ORA_SVC_CREATE_AND_INITIATE status indicates that the child plan actions are created and action plan is initiated. The ORA_SVC_CREATE_AND_INITIATE status skips the intermediate ORA_SVC_CREATED status.\nThe ORA_SVC_INITIATING status indicates that the action plan initiate process has started. The action plan status changes to ORA_SVC_IN_PROGRESS if it is able to successfully create underlying objects.\nIf there is a failure in creating underlying objects, then the status changes to ORA_SVC_ERROR. For the ORA_SVC_ERROR status, the error details are stored in 'Status Details??? attribute of either 'action plan' object or its child ???action plan action' object.\nThe ORA_SVC_COMPLETED status indicates that all actions in the action plan are complete.",
            "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.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StatusCd"
                ]
            },
            "x-queryable":true
        },
        "StatusDetails":{
            "title":"Status Details",
            "maxLength":2000,
            "type":"string",
            "description":"The explanation of the error status of the 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 plan 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
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "actionPlanAction":{
            "title":"Action Plan Actions",
            "type":"array",
            "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
            "items":{
                "$ref":"#/components/schemas/actionplans-actionPlanAction-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 Actions

Type: array

Title: Action Plan Actions

The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.

Show Source

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

{
    "title":"Action Plan Actions",
    "type":"array",
    "description":"The actions plan actions resource is used to view, create, update, and delete the actions in an action plan. An action is a step or a sequence in an action plan.",
    "items":{
        "$ref":"#/components/schemas/actionplans-actionPlanAction-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-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

addActionToObject

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/addActionToObject

Adds action to an object and creates action plan. The action and parent business object are specified in the input by action number, object type and object number.

addAdhocActiontoActionPlan

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/addAdhocActiontoActionPlan

Adds adhoc actions to a single action plan or multiple action plans. The actions and action plans are specified by a given list of action plan numbers and action numbers.

getActionMappings

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/getActionMappings

This method lets you retrieve attribute mappings for the given action plan or action plan action with resolved values.

getProcessAccessToken

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/getProcessAccessToken

This method is used to obtain the JWT token for a logged-in user to connect to the pcs instance. This method should only be used from VBCS to generate the token.

processSignalObject

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/processSignalObject

Refreshes an action plan action that has already been initiated through signals.

recreateObjectForActionPlanAction

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/recreateObjectForActionPlanAction

Recreates the underlying business object of the corresponding action plan action such as SR, Task, or Appointment, that has failed during previous orchestration.

refreshActionPlan

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlan

Refreshes an action plan that has already been initiated.

refreshActionPlanAction

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/refreshActionPlanAction

Refreshes an action plan action that has already been initiated.

updateObjectDetailsToPlan

Operation: /crmRestApi/resources/11.13.18.05/actionplans/action/updateObjectDetailsToPlan

Update child object identifier for an action plan or an action plan action and related dates. Perform a refresh action plan if required.

Back to Top

Examples

The following example shows how to get all action plans by submitting a GET request on the REST resource using cURL.

cURL Command

Command: curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actionplans

Example of Response Body

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

{
"items": [
  {
"ActionPlanId": 300100117572596,
"ActualCompletionDate": null,
"CalendarId": 300100028308361,
"CreatedBy": "MHoope",
"CreationDate": "2017-09-15T00:56:43.626+00:00",
"DeletedFlag": false,
"ExpectedCompletionDate": "2017-09-20T05:58:00+00:00",
"InitialCompletionDate": "2017-09-16T02:57:00+00:00",
"StartDate": "2017-09-15T00:56:50.553+00:00",
"LastUpdateDate": "2017-09-15T02:53:23+00:00",
"LastUpdateLogin": "592E32349F671673E0538E09F20ACE8A",
"LastUpdatedBy": "SALES_ADMIN",
"Name": null,
"ObjectEntityName": "ServiceRequest",
"ObjectId": 300100117572404,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
},
{
"ActionPlanId": 300100111080994,
"ActualCompletionDate": null,
"CalendarId": 300100028308361,
"CreatedBy": "autoxtnapi90",
"CreationDate": "2017-07-12T05:41:02+00:00",
"DeletedFlag": false,
"ExpectedCompletionDate": null,
"InitialCompletionDate": null,
"StartDate": null,
"LastUpdateDate": "2017-07-12T05:41:02.006+00:00",
"LastUpdateLogin": "541749F1C18D4646E0538E09F20AB723",
"LastUpdatedBy": "autoxtnapi90",
"Name": null,
"ObjectEntityName": "ServiceRequest",
"ObjectId": 300100111082917,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
},
...

Back to Top