Jump to

• Request
• Response

Update a status condition

patch

/crmRestApi/resources/11.13.18.05/actionstatusconditions/{StatusConditionId}

Request

Path Parameters

• StatusConditionId(required): integer(int64)
  The unique identifier of the status condition.

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 lookup code that indicates the status to set into an action, if the condition is met.
• ChildObjectName: string
  Title: Entity Type

  Maximum Length: 400

  The name of the child of the object on which the status condition is based.
• Condition: string
  Title: Condition

  Maximum Length: 1000

  The expression that evaluates to true or false to indicate whether the condition is met or not.
• Description: string
  Title: Description

  Maximum Length: 1000

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

  Maximum Length: 400

  The name of the status condition for an action.
• ObjectEntityName: string
  Title: Entity Name

  Maximum Length: 400

  The entity name of the object on which the status condition is based.

{
    "type":"object",
    "properties":{
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the status to set into an action, if the condition is met.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ChildObjectName":{
            "title":"Entity Type",
            "maxLength":400,
            "type":"string",
            "description":"The name of the child of the object on which the status condition is based.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression that evaluates to true or false to indicate whether the condition is met or not.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the status condition for an action.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the status condition for an action.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ObjectEntityName":{
            "title":"Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The entity name of the object on which the status condition is based.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : actionstatusconditions-item-response

Type: object

Show Source

• ActionStatusCd: string
  Title: Action Status

  Maximum Length: 30

  The lookup code that indicates the status to set into an action, if the condition is met.
• ChildObjectName: string
  Title: Entity Type

  Maximum Length: 400

  The name of the child of the object on which the status condition is based.
• Condition: string
  Title: Condition

  Maximum Length: 1000

  The expression that evaluates to true or false to indicate whether the condition is met or not.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the record was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the status condition for an action.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

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

  Maximum Length: 400

  The name of the status condition for an action.
• ObjectEntityName: string
  Title: Entity Name

  Maximum Length: 400

  The entity name of the object on which the status condition is based.
• StatusConditionId: integer (int64)
  Title: Action Status Condition ID

  Read Only: true

  The unique identifier of the status condition.

{
    "type":"object",
    "properties":{
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the status to set into an action, if the condition is met.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ChildObjectName":{
            "title":"Entity Type",
            "maxLength":400,
            "type":"string",
            "description":"The name of the child of the object on which the status condition is based.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Condition":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The expression that evaluates to true or false to indicate whether the condition is met or not.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the status condition for an action.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the status condition for an action.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ObjectEntityName":{
            "title":"Entity Name",
            "maxLength":400,
            "type":"string",
            "description":"The entity name of the object on which the status condition is based.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "StatusConditionId":{
            "title":"Action Status Condition ID",
            "type":"integer",
            "description":"The unique identifier of the status condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

Back to Top