Get all action plan actions
get
/crmRestApi/resources/11.13.18.05/actionplans/{ActionPlanId}/child/actionPlanAction
Request
Path Parameters
-
ActionPlanId(required): integer(int64)
The unique identifier of the action plan.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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:- PrimaryKey: Finds an action plan action with the specified primary key.
Finder Variables:- ActionPlanActionId; integer; The unique identifier of the action plan action.
- PrimaryKey: Finds an action plan action with the specified primary key.
-
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:- ActionDescription; string; The description of an action in an action plan.
- ActionId; integer; The unique identifier of the action.
- ActionName; string; The name of the action.
- ActionPlanActionId; integer; The unique identifier of the action in an action plan.
- ActionPlanActionNumber; string; The alternate unique identifier of an action plan action.
- ActionPlanId; integer; The unique identifier of the action plan.
- ActionPlanNumber; string; The action plan reference number.
- CreatedBy; string; The user who created the action in an action plan.
- CreationDate; string; The date and time when the action was created in an action plan.
- DelayedFlag; boolean; Indicates whether the action in an action plan is delayed.
- DeletedFlag; boolean; Indicates whether the action in an action plan is deleted. The default value is false.
- EndDate; string; The date when an action in the action plan ends.
- EndDateReadOnlyFlag; boolean; Indicates whether the end date should be read only.
- ExpectedCompletionDate; string; The date when the action in an action plan is to be completed.
- ExpectedStartDate; string; The date when an action in the action plan is expected to start.
- LastUpdateDate; string; The date and time when the action was last updated in an action plan.
- LastUpdateLogin; string; The login details of the user who last updated the action in an action plan.
- LastUpdatedBy; string; The user who last updated the action in an action plan.
- LeadTime; integer; The estimated time required to complete the action.
- LeadTimeUnit; string; The unit of measurement of the lead time, such as minutes, hours, or days.
- LeadTimeUnitMeaning; string; The display value corresponding to the lead time unit lookup code for the action plan action.
- MandatoryFlag; boolean; Indicates whether the action in an action plan is mandatory. The default value is false.
- ObjectEntityName; string; The name of the parent entity object on which the action is based.
- ObjectEntityNameMeaning; string; The display value corresponding to the object entity name lookup code for the action plan action.
- ObjectEntitySubtype; string; Indicates the object entity subtype of the action in the action plan.
- ObjectEntityType; string; The type of the parent entity object on which the action is based.
- ObjectEntityTypeMeaning; string; The display value corresponding to the object entity type lookup code for the action plan action.
- ObjectId; integer; The unique identifier of the object associated with the action.
- ObjectReferenceNumber; string; The reference number of the object associated with the action.
- OrderNumber; integer; The order of the action in an action plan.
- OwnerName; string; The name of the owner of the action.
- Prerequisites; string; The prerequisite steps required to initiate the action.
- ProcessInstanceId; string; Indicates the process instance identifier of an external process.
- ProcessStatus; string; The status of the external process.
- SkipFlag; boolean; Indicates whether the action for the action plan can be skipped.
- StartDate; string; The date when an action in the action plan begins.
- StatusCd; string; 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; The display value corresponding to the status lookup code for the action plan action.
- StatusDetails; string; The details of the status of an action in an action plan.
- TemplateId; integer; The unique identifier of the action plan template from which the action is created.
- TemplateNumber; string; The reference number of the action plan template.
- TemplateTemplateId; integer; The unique identifier of a template.
- VisibilityCd; string; 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; The display value corresponding to the visibility lookup code for the action plan action.
-
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : actionplans-actionPlanAction
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : actionplans-actionPlanAction-item-response
Type:
Show Source
object
-
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.
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : actionplans-actionPlanAction-actionPlanActionRelation-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to get all the actions in an action plan 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/300100117534967/child/actionPlanAction
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ActionId": 300100117527290, "ActionPlanActionId": 300100117534968, "ActionPlanId": 300100117534967, "CreatedBy": "autoxtnapi90", "CreationDate": "2017-09-14T09:05:08.006+00:00", "DelayedFlag": true, "DeletedFlag": false, "EndDate": "2017-09-26T11:48:00+00:00", "ExpectedCompletionDate": "2017-09-15T11:06:00+00:00", "ExpectedStartDate": "2017-09-15T09:06:00+00:00", "LastUpdateDate": "2017-09-27T14:05:44.762+00:00", "LastUpdateLogin": "5A2B9616EDB55FF2E0538E09F20A4251", "LastUpdatedBy": "autoxtnapi90", "LeadTime": 2, "LeadTimeUnit": "ORA_SVC_HOURS", "MandatoryFlag": true, "ObjectId": 300100118782699, "ObjectReferenceNumber": null, "OrderNumber": 3, "StartDate": "2017-09-26T09:47:37.447+00:00", "StatusCd": "ORA_SVC_IN_PROGRESS", "StatusDetails": null, "TemplateId": 300100117534921, "OwnerName": "Gabrielle Lee", "Prerequisites": "1, 5", "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": [ ... ] }, { "ActionId": 300100117527294, "ActionPlanActionId": 300100117534969, "ActionPlanId": 300100117534967, "CreatedBy": "autoxtnapi90", "CreationDate": "2017-09-14T09:05:08.115+00:00", "DelayedFlag": false, "DeletedFlag": false, "EndDate": "2017-09-14T09:05:18.561+00:00", "ExpectedCompletionDate": null, "ExpectedStartDate": null, "LastUpdateDate": "2017-09-14T09:05:21.614+00:00", "LastUpdateLogin": "59217E93DA3C30D0E0538E09F20A0E64", "LastUpdatedBy": "autoxtnapi90", "LeadTime": 3, "LeadTimeUnit": "ORA_SVC_HOURS", "MandatoryFlag": false, "ObjectId": null, "ObjectReferenceNumber": null, "OrderNumber": 5, "StartDate": "2017-09-14T09:05:18.560+00:00", "StatusCd": "ORA_SVC_CANCELED", "StatusDetails": null, "TemplateId": 300100117534921, "OwnerName": null, "Prerequisites": "2, 4", "ObjectEntityName": "ServiceRequest", "ObjectEntityType": "ServiceRequest", "VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE", "ActionName": "action149_2", "UpdateFlag": true, "DeleteFlag": true, "ActionNumber": "ACT0000043280", "ActionDescription": null, "EndDateReadOnlyFlag": true, "DclActionPlan_Id_c": null, "DclActionPlan_c": null, "links": [ ... ] }