Jump to

• Request
• Response
• Examples

Update an action plan template

patch

/crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}

Request

Path Parameters

• TemplateId(required): integer(int64)
  The unique identifier of the action plan template.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action plan template has been deleted. The default value is false.
• 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.
• 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.
• 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.

{
    "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"
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated to the template.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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
            }
        },
        "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"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action plan template.",
            "nullable":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"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the action plan template ends.",
            "format":"date-time",
            "nullable":true
        },
        "Name":{
            "title":"Template",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action plan template.",
            "nullable":false
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the action plan template starts.",
            "format":"date-time",
            "nullable":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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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-patch-request"
            }
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• 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.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the template action has been deleted. The default value is false.
• 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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "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"
            }
        },
        "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
            }
        },
        "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-patch-request"
            }
        }
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : schema

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.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the action dependency has been deleted. The default value is false.
• DepTemplateActionId: integer (int64)
  Title: Dependent Template Action ID

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

{
    "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"
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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
            }
        }
    }
}

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

Links

ActionPlanTypeLookupPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_ACTION_PLAN_TYPE_CD

The list of values indicating the type of action plan the template is associated with.

The following properties are defined on the LOV link relation:

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

BusinessUnitLOV

Operation: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

The list of values indicating the name of the business unit associated to the template.

The following properties are defined on the LOV link relation:

• Source Attribute: BusinessUnitName; Target Attribute: Name
• Display Attribute: Name

ObjectEntityNameLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_PARENT_ENTITY_NAME

The list of values indicating the application context of the action plan template.

The following properties are defined on the LOV link relation:

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

StripeCdLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

The following properties are defined on the LOV link relation:

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

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating if the action plan will initiate automatically after the creation.

The following properties are defined on the LOV link relation:

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

templateAction

Operation: /crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction

Parameters:

• TemplateId: $request.path.TemplateId

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

Back to Top

Examples

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

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actiontemplates/300100118921028

Example of Request Body

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

{
"Name" : "REST-t2"
}

Example of Response Body

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

{
"ActionPlanTypeCd": null,
"CalendarId": 300100028308361,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T14:41:48+00:00",
"DeletedFlag": false,
"Description": null,
"EnabledFlag": true,
"EndDate": null,
"LastUpdateDate": "2017-09-27T14:43:53+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"Name": "REST-t2",
"ObjectEntityName": "ServiceRequest",
"StartDate": null,
"TemplateId": 300100118921028,
"CoverageName": "24 by 7",
"CoverageTimeId": 300100028308361,
"UpdateFlag": true,
"DeleteFlag": true,
"DclTemplate_Id_c": null,
"DclTemplate_c": null,
"links": [
 ...
 ]
}

Back to Top