Get all actions
get
/crmRestApi/resources/11.13.18.05/actions
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:- ActionAltKey: Finds an action with the specified alternate unique key.
Finder Variables:- ActionNumber; string; The alternate unique identifier of the action.
- ActionByActionNumber: Finds an action with the specified alternate unique identifier.
Finder Variables:- ActionNumber; string; The alternate unique identifier of the action.
- PrimaryKey: Finds an action with the specified primary key.
Finder Variables:- ActionId; integer; The unique identifier of the action.
- ActionAltKey: Finds an action with the specified alternate unique 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:- ActionCategoryCd; string; The code indicating the category of the action. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_CATEGORY_CD.
- ActionCategoryCdMeaning; string; The display value corresponding to the action category lookup code for the action.
- ActionId; integer; The unique identifier of the action.
- ActionNumber; string; The alternate unique identifier of the action.
- BUOrgId; integer; The unique identifier of the business unit name associated to the action.
- BusinessUnitName; string; The name of the business unit associated to the action.
- CopyAttachmentsFlag; boolean; Indicates whether the attachments are copied from the parent context to the child object.
- CreatedBy; string; The user who created the action.
- CreationDate; string; The date and time when the action was created.
- DeletedFlag; boolean; Indicates whether the action is deleted. The default value is false.
- Description; string; The description of the action.
- LastUpdateDate; string; The date and time when the action was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the action.
- LastUpdatedBy; string; The user who last updated the action.
- 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.
- Name; string; The name of the action.
- ObjectEntityName; string; The entity name of the object on which the action is based.
- ObjectEntityNameMeaning; string; The display value corresponding to the object entity name lookup code for the action.
- ObjectEntitySubtype; string; Indicates the subtype of the object on which the action is based.
- ObjectEntityType; string; The type of the entity object on which the action is based.
- ObjectEntityTypeMeaning; string; The display value corresponding to the object entity type lookup code for the action.
- ObjectLinkTypeId; integer; The object link type identifier associated to the action.
- OperationCd; string; The operation code entry for the action. A list of valid values is defined in the lookup ORA_SVC_AP_OPERATION_CD.
- OperationCdMeaning; string; The display value corresponding to the operation lookup code for the action.
- OriginalSystemReference; string; The reference to the original system from which the action was imported (if imported).
- ParentEntityName; string; The entity name of the object on which the action is used.
- ParentEntityNameMeaning; string; The display value corresponding to the parent entity name lookup code for the action.
- ProcessConnectionTypeCd; string; The lookup code that indicates if the connection to Process Cloud is basic or integrated.
- ProcessMetadataId; integer; The unique identifier of the process metadata.
- ProcessMetadataNumber; string; The reference number of the process metadata.
- StripeCd; string; The application context of the action.
- StripeCdMeaning; string; The display value corresponding to the stripe lookup code for the action.
- UseDefaultVersionFlag; boolean; Indicates whether the default process version is used.
- 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.
-
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 : actions
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 : actions-item-response
Type:
Show Source
object
-
actionAttribute: array
Action Attributes
Title:
Action Attributes
The action attributes resource is used to view, create, update, and delete the attributes that are set while creating or updating the related object of an action. -
ActionCategoryCd: string
Title:
Category
Maximum Length:30
The code indicating the category of the action. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_CATEGORY_CD. -
ActionCategoryCdMeaning: string
Title:
Action Category Value
Maximum Length:255
The display value corresponding to the action category lookup code for the action. -
actionCondition: array
Action Conditions
Title:
Action Conditions
The action conditions resource is used to view, create, update, and delete the definitions of the status mapping conditions for the related object of an action. -
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
Maximum Length:64
The alternate unique identifier of the action. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
The unique identifier of the business unit name associated to the action. -
BusinessUnitName: string
Title:
Business Unit ID
The name of the business unit associated to the action. -
CopyAttachmentsFlag: boolean
Title:
Copy Attachments
Maximum Length:1
Default Value:false
Indicates whether the attachments are copied from the parent context to the child object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the action was created. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the action is deleted. The default value is false. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action can be deleted. -
Description: string
Title:
Description
Maximum Length:1000
The description of the action. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Action
Maximum Length:400
The name of the action. -
ObjectEntityName: string
Title:
Entity Name
Maximum Length:400
The entity name of the 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. -
ObjectEntitySubtype: string
Title:
Object Entity Subtype
Maximum Length:400
Indicates the subtype of the object on which the action is based. -
ObjectEntityType: string
Title:
Type
Maximum Length:400
The type of the 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. -
ObjectLinkTypeId: integer
(int64)
Title:
Object Link Type Id
The object link type identifier associated to the action. -
ObjectLinkTypeNumber: string
Title:
Link Type Number
Maximum Length:255
The public unique identifier of the object link type associated with the action. -
OperationCd: string
Title:
Operation Code
Maximum Length:30
The operation code entry for the action. A list of valid values is defined in the lookup ORA_SVC_AP_OPERATION_CD. -
OperationCdMeaning: string
Title:
Operation Value
Maximum Length:255
The display value corresponding to the operation lookup code for the action. -
OriginalSystemReference: string
Title:
Original System Reference
Maximum Length:255
The reference to the original system from which the action was imported (if imported). -
ParentEntityName: string
Title:
Context
Maximum Length:400
The entity name of the object on which the action is used. -
ParentEntityNameMeaning: string
Title:
Parent Entity Name Value
Maximum Length:255
The display value corresponding to the parent entity name lookup code for the action. -
ProcessConnectionTypeCd: string
Title:
Process Connection Type Code
Read Only:true
Maximum Length:30
Default Value:Integrated
The lookup code that indicates if the connection to Process Cloud is basic or integrated. -
ProcessMetadataId: integer
(int64)
Title:
Process Metadata ID
The unique identifier of the process metadata. -
ProcessMetadataNumber: string
Title:
Process Metadata Number
Maximum Length:30
The reference number of the process metadata. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The application context of the action. -
StripeCdMeaning: string
Title:
Stripe Value
Maximum Length:255
The display value corresponding to the stripe lookup code for the action. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action can be updated. -
UseDefaultVersionFlag: boolean
Title:
Use Default Version
Maximum Length:1
Default Value:false
Indicates whether the default process version is used. -
VisibilityCd: string
Title:
Visibility
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.
Nested Schema : Action Attributes
Type:
array
Title:
Action Attributes
The action attributes resource is used to view, create, update, and delete the attributes that are set while creating or updating the related object of an action.
Show Source
Nested Schema : Action Conditions
Type:
array
Title:
Action Conditions
The action conditions resource is used to view, create, update, and delete the definitions of the status mapping conditions for the related object of an action.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : actions-actionAttribute-item-response
Type:
Show Source
object
-
ActionAttributeId: integer
(int64)
Title:
Action Attribute ID
Read Only:true
The unique identifier of the action attribute. -
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
Maximum Length:64
The alternate unique identifier of the action. -
AttributeName: string
Title:
Attribute Name
Maximum Length:2000
The name of the action attribute. -
AttributeValue: string
Title:
Attribute Value
Maximum Length:1000
The value to be set for the action attribute. -
AttributeValueContextCd: string
Title:
Context
Maximum Length:30
Default Value:ORA_SVC_USER_DEFINED
The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup ORA_SVC_AP_CONTEXT_CD. -
AttributeValueContextCdMeaning: string
Title:
Context Value
Maximum Length:255
The display value corresponding to the context lookup code for the action attribute. -
ChildAttributeFlag: boolean
Title:
Child Attribute Indicator
Maximum Length:1
Default Value:false
Indicates whether this attribute belongs to the parent or one of its child objects. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action attribute. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the action attribute was created. -
DeletedFlag: boolean
Title:
Deleted
Maximum Length:1
Default Value:false
Indicates whether the attribute action is deleted. The default value is false. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action attribute can be deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action attribute was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action attribute can be updated. -
UsageCd: string
Title:
Usage
Maximum Length:30
Default Value:ORA_SVC_CREATE
The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD. -
UsageCdMeaning: string
Title:
Usage Value
Maximum Length:255
The display value corresponding to the usage lookup code for the action attribute.
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.
Nested Schema : actions-actionCondition-item-response
Type:
Show Source
object
-
ActionConditionId: integer
(int64)
Title:
Action Condition ID
Read Only:true
The unique identifier of the action condition. -
ActionId: integer
(int64)
Title:
Action ID
The unique identifier of the action. -
ActionNumber: string
Title:
Action Number
Maximum Length:64
The alternate unique identifier of the action. -
ActionStatusCd: string
Title:
Action Status
Maximum Length:30
The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD. -
ActionStatusCdMeaning: string
Title:
Action Status Value
Maximum Length:255
The display value corresponding to the action status lookup code for the action condition. -
CompletionFlag: boolean
Title:
CompletionFlag
Maximum Length:1
Indicates whether the action was completed by fulfilling the condition. The default value is false. -
Condition: string
Title:
Condition
Maximum Length:1000
The expression indicating whether the condition is met or not. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the action condition. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the condition was created. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the action condition can be deleted. -
Description: string
Title:
Description
Maximum Length:1000
The description of the action condition. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the action condition was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the action condition. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the action condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:400
The name of the action condition. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the action condition can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all actions by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actions
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "ActionCategoryCd": "CATEGORY 1", "ActionId": 300100118621756, "CreatedBy": "xuidrill2", "CreationDate": "2017-09-25T06:38:02+00:00", "DeletedFlag": false, "Description": "SR IN Progress to Blocked when Severity is HIGH", "LastUpdateDate": "2017-09-25T06:43:25.201+00:00", "LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F", "LastUpdatedBy": "xuidrill2", "LeadTime": 45, "LeadTimeUnit": "ORA_SVC_MINS", "Name": "ESS_SR_PP01", "ObjectEntityName": "ServiceRequest", "ParentEntityName": "ServiceRequest", "VisibilityCd": "ORA_SVC_INTERNAL_ONLY", "OperationCd": "ORA_SVC_CREATE", "ObjectEntityType": "ServiceRequest", "ActionNumber": "ACT0000044367", "OriginalSystemReference": "ACT0000044367", "DeleteFlag": true, "UpdateFlag": true, "DclAction_Id_c": null, "DclAction_c": null, "links": [ ... ] }, { "ActionCategoryCd": "CATEGORY 1", "ActionId": 300100118621849, "CreatedBy": "xuidrill2", "CreationDate": "2017-09-25T06:43:59.001+00:00", "DeletedFlag": false, "Description": "APP IN PROGRESS to Completed", "LastUpdateDate": "2017-09-25T06:47:18.960+00:00", "LastUpdateLogin": "59FCEEEABAA256BBE0538E09F20A384F", "LastUpdatedBy": "xuidrill2", "LeadTime": 15, "LeadTimeUnit": "ORA_SVC_MINS", "Name": "ESS_APP_PP02", "ObjectEntityName": "Activity", "ParentEntityName": "ServiceRequest", "VisibilityCd": "ORA_SVC_CUSTOMER_VISIBLE", "OperationCd": "ORA_SVC_CREATE", "ObjectEntityType": "Appointment", "ActionNumber": "ACT0000044368", "OriginalSystemReference": "ACT0000044368", "DeleteFlag": true, "UpdateFlag": true, "DclAction_Id_c": null, "DclAction_c": null, "links": [ ... ] }, ...