Jump to

• Request
• Response
• Examples

Get all action plan templates

get

/crmRestApi/resources/11.13.18.05/actiontemplates

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:
  
  

  • PrimaryKey: Finds an action plan template with the specified primary key.
    Finder Variables:
    • TemplateId; integer; The unique identifier of the action plan template.
  • TemplateAltKey: Finds a template with the specified alternate unique identifier.
    Finder Variables:
    • TemplateNumber; string; The alternate unique identifier of the template.
• 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:
  

  • ActionPlanTypeCd; string; The code indicating the type of the action plan with which the template is associated. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_PLAN_TYPE_CD.
  • ActionPlanTypeCdMeaning; string; The display value corresponding to the action plan type lookup code for the template.
  • AutoStartFlag; boolean; Indicates whether the action plans created using the template start automatically.
  • BUOrgId; integer; The unique identifier of the business unit name associated to the action plan template.
  • BusinessUnitName; string; The name of the business unit associated to the template.
  • CalendarId; integer; The unique identifier of the calendar that is associated with the action plan template.
  • CoverageName; string; The name of the calendar associated with the action plan template.
  • CoverageTimeId; integer; The unique identifier of the calendar associated with the action plan template.
  • CreatedBy; string; The user who created the action plan template.
  • CreationDate; string; The date and time when the action plan template was created.
  • DeletedFlag; boolean; Indicates whether the action plan template has been deleted. The default value is false.
  • Description; string; The description of the action plan template.
  • EnabledFlag; boolean; Indicates whether the action plan template is enabled in the system. The default value is true.
  • EndDate; string; The date when the action plan template ends.
  • LastUpdateDate; string; The date and time when the action plan template was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the action plan template.
  • LastUpdatedBy; string; The user who last updated the action plan template.
  • Name; string; The name of the action plan template.
  • ObjectEntityName; string; The name of the object entity that the template uses to create action plans.
  • ObjectEntityNameMeaning; string; The display value corresponding to the object entity name lookup code for the template.
  • SchedulePuid; string; The public unique identifier of a standard coverage schedule.
  • StartDate; string; The date when the action plan template starts.
  • StripeCd; string; The application context of the action plan template.
  • StripeCdMeaning; string; The display value corresponding to the stripe lookup code for the template.
  • TemplateId; integer; The unique identifier of the action plan template.
  • TemplateNumber; string; The reference number of the action plan template.
• 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 : actiontemplates

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/actiontemplates-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 actiontemplates-item-response

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

Type: object

Show Source

• ActionPlanTypeCd: string
  Title: Category

  Maximum Length: 30

  The code indicating the type of the action plan with which the template is associated. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_PLAN_TYPE_CD.
• ActionPlanTypeCdMeaning: string
  Title: Action Plan Type Value

  Maximum Length: 255

  The display value corresponding to the action plan type lookup code for the template.
• AutoStartFlag: boolean
  Title: Auto Start

  Maximum Length: 1

  Default Value: false

  Indicates whether the action plans created using the template start automatically.
• BUOrgId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit name associated to the action plan template.
• BusinessUnitName: string
  Title: Business Unit

  The name of the business unit associated to the template.
• CalendarId: integer (int64)
  Title: Calendar

  The unique identifier of the calendar that is associated with the action plan template.
• CoverageName: string
  Title: Calendar

  Read Only: true

  The name of the calendar associated with the action plan template.
• CoverageTimeId: integer
  Title: Coverage Time ID

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Default Value: false

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

  Indicates whether the action plan template can be deleted.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the action plan template.
• EnabledFlag: boolean
  Title: Published

  Maximum Length: 1

  Default Value: false

  Indicates whether the action plan template is enabled in the system. The default value is true.
• EndDate: string (date-time)
  Title: End Date

  The date when the action plan template ends.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• Name: string
  Title: Template

  Maximum Length: 400

  The name of the action plan template.
• ObjectEntityName: string
  Title: Context

  Maximum Length: 400

  The name of the object entity that the template uses to create action plans.
• ObjectEntityNameMeaning: string
  Title: Object Entity Name Value

  Maximum Length: 255

  The display value corresponding to the object entity name lookup code for the template.
• 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 template starts.
• StripeCd: string
  Title: Stripe Code

  Maximum Length: 30

  The application context of the action plan template.
• StripeCdMeaning: string
  Title: Stripe Value

  Maximum Length: 255

  The display value corresponding to the stripe lookup code for the template.
• templateAction: array Template Actions
  Title: Template Actions

  The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.
• TemplateId: integer (int64)
  Title: Template ID

  The unique identifier of the action plan template.
• 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 template can be updated.

{
    "type":"object",
    "properties":{
        "ActionPlanTypeCd":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the action plan with which the template is associated. A list of valid values is defined in the lookup ORA_SVC_AP_ACTION_PLAN_TYPE_CD.",
            "nullable":true,
            "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 template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionPlanTypeCd"
                ]
            },
            "x-queryable":true
        },
        "AutoStartFlag":{
            "title":"Auto Start",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plans created using the template start automatically.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit name associated to the action plan template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated to the template.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar",
            "type":"integer",
            "description":"The unique identifier of the calendar that is associated with the action plan template.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Calendar",
            "type":"string",
            "description":"The name of the calendar associated with the action plan template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageTimeId":{
            "title":"Coverage Time ID",
            "type":"integer",
            "description":"The unique identifier of the calendar associated with the action plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action plan template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action plan template can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan template has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action plan template.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Published",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action plan template is enabled in the system. The default value is true.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the action plan template ends.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action plan template 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 template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"LastUpdatedBy",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action plan template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Template",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action plan template.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Context",
            "maxLength":400,
            "type":"string",
            "description":"The name of the object entity that the template uses to create action plans.",
            "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 template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "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 template starts.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The application context of the action plan template.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ObjectEntityName"
                ]
            },
            "x-queryable":true
        },
        "StripeCdMeaning":{
            "title":"Stripe Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the stripe lookup code for the template.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "StripeCd"
                ]
            },
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template.",
            "format":"int64",
            "nullable":false,
            "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 template 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"
            }
        },
        "templateAction":{
            "title":"Template Actions",
            "type":"array",
            "description":"The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.",
            "items":{
                "$ref":"#/components/schemas/actiontemplates-templateAction-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 : Template Actions

Type: array

Title: Template Actions

The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.

Show Source

• Array of: object actiontemplates-templateAction-item-response

{
    "title":"Template Actions",
    "type":"array",
    "description":"The template actions resource is used to view, create, update, and delete the associations of actions with action plan templates.",
    "items":{
        "$ref":"#/components/schemas/actiontemplates-templateAction-item-response"
    }
}

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."
        }
    }
}

Nested Schema : actiontemplates-templateAction-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Title: Action ID

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

  Maximum Length: 64

  The reference number of the action.
• actionRelation: array Action Relations
  Title: Action Relations

  The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who added the action to the template.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the action was added to the template.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

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

  Indicates whether the template action can be deleted.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the template 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 true.
• OrderNumber: integer (int64)
  Title: Sort Number

  The order of display for an action within an action template.
• Prerequisites: string
  Read Only: true

  The prerequisite action steps for the action.
• TemplateActionId: integer (int64)
  Title: Template Action ID

  Read Only: true

  The unique identifier of the template action.
• TemplateActionNumber: string
  Title: Template Action Number

  Maximum Length: 30

  The template action reference number.
• TemplateId: integer (int64)
  Title: Template ID

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

  Maximum Length: 30

  The reference number of the action plan template.
• Tier: integer
  Read Only: true

  The tier used in an action plan diagram to display the action nodes at appropriate levels.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the template action can be updated.

{
    "type":"object",
    "properties":{
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":64,
            "type":"string",
            "description":"The reference number of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who added the action to the template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action was added to the template.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the template action can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the template action has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the template action 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 template action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the template action.",
            "nullable":false,
            "readOnly":true,
            "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 true.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The order of display for an action within an action template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Prerequisites":{
            "type":"string",
            "description":"The prerequisite action steps for the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateActionId":{
            "title":"Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the template action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionNumber":{
            "title":"Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the action plan template.",
            "format":"int64",
            "nullable":false,
            "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
        },
        "Tier":{
            "type":"integer",
            "description":"The tier used in an action plan diagram to display the action nodes at appropriate levels.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the template action can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "actionRelation":{
            "title":"Action Relations",
            "type":"array",
            "description":"The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.",
            "items":{
                "$ref":"#/components/schemas/actiontemplates-templateAction-actionRelation-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Action Relations

Type: array

Title: Action Relations

The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.

Show Source

• Array of: object actiontemplates-templateAction-actionRelation-item-response

{
    "title":"Action Relations",
    "type":"array",
    "description":"The action relations resource is used to view, create, update, and delete the dependencies of actions on other actions in an action plan template.",
    "items":{
        "$ref":"#/components/schemas/actiontemplates-templateAction-actionRelation-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 : actiontemplates-templateAction-actionRelation-item-response

Type: object

Show Source

• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  Default Value: ORA_SVC_COMPLETED

  The status code which indicates the dependency condition of an action relation. 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 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 has been deleted. The default value is false.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the action relation can be deleted.
• DepTemplateActionId: integer (int64)
  Title: Dependent Template Action ID

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

  Maximum Length: 30

  The template action reference number of a dependent action.
• DepTmpActionOrderNumber: integer (int64)
  Title: Sort Number

  Read Only: true

  The order of display for an action within an action template.
• 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 an action.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

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

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

  The unique identifier of the relation between the actions in an action plan.
• TemplateActionId: integer (int64)
  Title: Template Action ID

  The unique identifier of the template action.
• TemplateActionNumber: string
  Title: Template Action Number

  Maximum Length: 30

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

  Indicates whether the action relation can be updated.

{
    "type":"object",
    "properties":{
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code which indicates the dependency condition of an action relation. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED",
            "x-queryable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action relation.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "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 relation can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DepTemplateActionId":{
            "title":"Dependent Template 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
        },
        "DepTemplateActionNumber":{
            "title":"Dependent Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number of a dependent action.",
            "nullable":false,
            "x-queryable":true
        },
        "DepTmpActionOrderNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The order of display for an action within an action template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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 action dependency.",
            "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 an action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationId":{
            "title":"Relation ID",
            "type":"integer",
            "description":"The unique identifier of the relation between the actions in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionId":{
            "title":"Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the template action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionNumber":{
            "title":"Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action relation 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"
    }
}

Back to Top

Examples

The following example shows how to get all action templates 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/actiontemplates

Example of Response Body

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

{
"items": [
  {
"ActionPlanTypeCd": null,
"CalendarId": 300100028308361,
"CreatedBy": "autoxtnapi90",
"CreationDate": "2017-09-26T04:35:27+00:00",
"DeletedFlag": false,
"Description": null,
"EnabledFlag": true,
"EndDate": null,
"LastUpdateDate": "2017-09-26T04:38:50.624+00:00",
"LastUpdateLogin": "5A110B3702AB2374E0538E09F20AA247",
"LastUpdatedBy": "autoxtnapi90",
"Name": "test_26838643_bug",
"ObjectEntityName": "ServiceRequest",
"StartDate": "2017-09-26T00:00:00+00:00",
"TemplateId": 300100118701852,
"CoverageName": "24 by 7",
"CoverageTimeId": 300100028308361,
"UpdateFlag": true,
"DeleteFlag": true,
"DclTemplate_Id_c": null,
"DclTemplate_c": null,
"links": [
 ...
 ]
},
{
"ActionPlanTypeCd": null,
"CalendarId": 300100028308361,
"CreatedBy": "autouicase1",
"CreationDate": "2017-09-26T00:16:31+00:00",
"DeletedFlag": false,
"Description": "Auto_APTemplate_DESC_Multi_PreReqs_25092017_171629.949",
"EnabledFlag": true,
"EndDate": null,
"LastUpdateDate": "2017-09-26T00:18:29.258+00:00",
"LastUpdateLogin": "5A0D0227FB64731EE0538E09F20A7BA2",
"LastUpdatedBy": "autouicase1",
"Name": "Auto_APTemplate_Multi_PreReqs_25092017_171629.949",
"ObjectEntityName": "ServiceRequest",
"StartDate": "2017-09-26T00:00:00+00:00",
"TemplateId": 300100118669128,
"CoverageName": "24 by 7",
"CoverageTimeId": 300100028308361,
"UpdateFlag": true,
"DeleteFlag": true,
"DclTemplate_Id_c": null,
"DclTemplate_c": null,
"links": [
 ...
 ]
},
...

Back to Top