Jump to

• Request
• Response
• Examples

Create an action attribute

post

/crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionAttribute

Request

Path Parameters

• ActionNumber(required): string
  The alternate unique identifier of the action.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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 alternate unique identifier of the action.
• AttributeName: string
  Title: Attribute Name

  Maximum Length: 2000

  The name of the action attribute.
• AttributeValue: string
  Title: Attribute Value

  Maximum Length: 1000

  The value to be set for the action attribute.
• AttributeValueContextCd: string
  Title: Context

  Maximum Length: 30

  Default Value: ORA_SVC_USER_DEFINED

  The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup ORA_SVC_AP_CONTEXT_CD.
• AttributeValueContextCdMeaning: string
  Title: Context Value

  Maximum Length: 255

  The display value corresponding to the context lookup code for the action attribute.
• ChildAttributeFlag: boolean
  Title: Child Attribute Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether this attribute belongs to the parent or one of its child objects.
• DeletedFlag: boolean
  Title: Deleted

  Maximum Length: 1

  Default Value: false

  Indicates whether the attribute action is deleted. The default value is false.
• UsageCd: string
  Title: Usage

  Maximum Length: 30

  Default Value: ORA_SVC_CREATE

  The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.
• UsageCdMeaning: string
  Title: Usage Value

  Maximum Length: 255

  The display value corresponding to the usage lookup code for the action attribute.

{
    "type":"object",
    "properties":{
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value to be set for the action attribute.",
            "nullable":true
        },
        "UsageCd":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.",
            "nullable":false,
            "default":"ORA_SVC_CREATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsageCdMeaning":{
            "title":"Usage Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the usage lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UsageCd"
                ]
            }
        },
        "AttributeValueContextCdMeaning":{
            "title":"Context Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the context lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueContextCd"
                ]
            }
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttributeValueContextCd":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup  ORA_SVC_AP_CONTEXT_CD.",
            "nullable":false,
            "default":"ORA_SVC_USER_DEFINED",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"2000",
            "type":"string",
            "description":"The name of the action attribute.",
            "nullable":false
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false
        },
        "ChildAttributeFlag":{
            "title":"Child Attribute Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this attribute belongs to the parent or one of its child objects.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : actions-actionAttribute-item-response

Type: object

Show Source

• ActionAttributeId: integer (int64)
  Title: Action Attribute ID

  Read Only: true

  The unique identifier of the action attribute.
• ActionId: integer (int64)
  Title: Action ID

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

  Maximum Length: 64

  The alternate unique identifier of the action.
• AttributeName: string
  Title: Attribute Name

  Maximum Length: 2000

  The name of the action attribute.
• AttributeValue: string
  Title: Attribute Value

  Maximum Length: 1000

  The value to be set for the action attribute.
• AttributeValueContextCd: string
  Title: Context

  Maximum Length: 30

  Default Value: ORA_SVC_USER_DEFINED

  The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup ORA_SVC_AP_CONTEXT_CD.
• AttributeValueContextCdMeaning: string
  Title: Context Value

  Maximum Length: 255

  The display value corresponding to the context lookup code for the action attribute.
• ChildAttributeFlag: boolean
  Title: Child Attribute Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether this attribute belongs to the parent or one of its child objects.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Default Value: false

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

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the action attribute can be updated.
• UsageCd: string
  Title: Usage

  Maximum Length: 30

  Default Value: ORA_SVC_CREATE

  The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.
• UsageCdMeaning: string
  Title: Usage Value

  Maximum Length: 255

  The display value corresponding to the usage lookup code for the action attribute.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":"1000",
            "type":"string",
            "description":"The value to be set for the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionAttributeId":{
            "title":"Action Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeValueContextCdMeaning":{
            "title":"Context Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the context lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueContextCd"
                ]
            },
            "x-queryable":true
        },
        "ActionNumber":{
            "title":"Action Number",
            "maxLength":"64",
            "type":"string",
            "description":"The alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action attribute can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action attribute can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UsageCd":{
            "title":"Usage",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating when the attribute is to be used. A list of valid values is defined in the lookup ORA_SVC_AP_ATTRIBUTE_USAGE_CD.",
            "nullable":false,
            "default":"ORA_SVC_CREATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsageCdMeaning":{
            "title":"Usage Value",
            "maxLength":"255",
            "type":"string",
            "description":"The display value corresponding to the usage lookup code for the action attribute.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "UsageCd"
                ]
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attribute action is deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttributeValueContextCd":{
            "title":"Context",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the context within which the attribute value is interpreted. A list of valid values is defined in the lookup  ORA_SVC_AP_CONTEXT_CD.",
            "nullable":false,
            "default":"ORA_SVC_USER_DEFINED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":"2000",
            "type":"string",
            "description":"The name of the action attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ChildAttributeFlag":{
            "title":"Child Attribute Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this attribute belongs to the parent or one of its child objects.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action attribute 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 attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

UsageCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_ATTRIBUTE_USAGE_CD

The list of values indicating when to use an action attribute.

The following properties are defined on the LOV link relation:

• Source Attribute: UsageCd; Target Attribute: LookupCode
• Display Attribute: LookupCode

YesNoLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The list of values indicating if this attribute belongs to the parent or one of its chid objects.

The following properties are defined on the LOV link relation:

• Source Attribute: ChildAttributeFlag; Target Attribute: LookupCode
• Display Attribute: LookupCode

Back to Top

Examples

The following example shows how to create an action attribute by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/actions/ACT0000044367/child/actionAttribute

Example of Request Body

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

{
"AttributeName" : "Subject",
"AttributeValueContextCd" : "ORA_SVC_CUSTOM",
"DeletedFlag" : "N",
"UsageCd" : "ORA_SVC_CREATE"
}

Example of Response Body

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

{
"ActionAttributeId": 300100118913154,
"ActionId": 300100118621756,
"AttributeName": "Subject",
"AttributeValue": null,
"AttributeValueContextCd": "ORA_SVC_CUSTOM",
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T12:58:24+00:00",
"DeletedFlag": false,
"LastUpdateDate": "2017-09-27T12:58:24.014+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"UsageCd": "ORA_SVC_CREATE",
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
}

Back to Top