Jump to

• Request
• Response
• Examples

Update an action condition

patch

/crmRestApi/resources/11.13.18.05/actions/{ActionNumber}/child/actionCondition/{ActionConditionId}

Request

Path Parameters

• ActionConditionId(required): integer(int64)
  The unique identifier of the action condition.
• ActionNumber(required): string
  The alternate unique identifier of the action.

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

• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.
• ActionStatusCdMeaning: string
  Title: Action Status Value

  Maximum Length: 255

  The display value corresponding to the action status lookup code for the action condition.
• CompletionFlag: boolean
  Title: CompletionFlag

  Maximum Length: 1

  Indicates whether the action was completed by fulfilling the condition. The default value is false.
• Condition: string
  Title: Condition

  Maximum Length: 1000

  The expression indicating whether the condition is met or not.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the action condition.
• Name: string
  Title: Name

  Maximum Length: 400

  The name of the action condition.

{
    "type":"object",
    "properties":{
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action condition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            }
        },
        "CompletionFlag":{
            "title":"CompletionFlag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action was completed by fulfilling the condition. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression indicating whether the condition is met or not.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action condition.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action condition.",
            "nullable":true
        }
    }
}

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-actionCondition-item-response

Type: object

Show Source

• ActionConditionId: integer (int64)
  Title: Action Condition ID

  Read Only: true

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

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

  Maximum Length: 64

  The alternate unique identifier of the action.
• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.
• ActionStatusCdMeaning: string
  Title: Action Status Value

  Maximum Length: 255

  The display value corresponding to the action status lookup code for the action condition.
• CompletionFlag: boolean
  Title: CompletionFlag

  Maximum Length: 1

  Indicates whether the action was completed by fulfilling the condition. The default value is false.
• Condition: string
  Title: Condition

  Maximum Length: 1000

  The expression indicating whether the condition is met or not.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the condition was created.
• DeleteFlag: boolean
  Read Only: true

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

  Maximum Length: 1000

  The description of the action condition.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

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

  Maximum Length: 400

  The name of the action condition.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the action condition can be updated.

{
    "type":"object",
    "properties":{
        "ActionConditionId":{
            "title":"Action Condition ID",
            "type":"integer",
            "description":"The unique identifier of the action condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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 alternate unique identifier of the action.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the action based on whether the condition is met or not. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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 condition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "CompletionFlag":{
            "title":"CompletionFlag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action was completed by fulfilling the condition. The default value is false.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression indicating whether the condition is met or not.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the action condition.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action condition 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 condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the action condition.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action condition 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"
    }
}

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

ActionStatusCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_AP_STATUS_CD

The list of values indicating the status of an action condition.

The following properties are defined on the LOV link relation:

• Source Attribute: ActionStatusCd; 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 the completion status of an action.

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

The following example shows how to update an action condition 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/actions/ACT0000044368/child/actionCondition/300100118914903

Example of Request Body

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

{
"Description": "Incomplete"
}

Example of Response Body

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

{
"ActionConditionId": 300100118914903,
"ActionId": 300100118621849,
"ActionStatusCd": "ORA_SVC_CANCELED",
"Condition": "(Location LIKE '%KM_Completed%')",
"CompletionFlag": true,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-09-27T13:18:37+00:00",
"Description": "Incomplete",
"LastUpdateDate": "2017-09-27T13:29:19+00:00",
"LastUpdateLogin": "5A2BD805BC436ED2E0538E09F20A9D1F",
"LastUpdatedBy": "SALES_ADMIN",
"Name": null,
"UpdateFlag": true,
"DeleteFlag": true,
"links": [
 ...
 ]
}

Back to Top