Jump to

• Request
• Response

Update an access group condition

patch

/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition/{RuleConditionNumber}

Request

Path Parameters

• RuleConditionNumber(required): string
  The rule condition number.
• RuleNumber(required): string
  The rule number of the rule. The user can either provide this value or the system generated number.

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

• Object: string
  Title: Object

  Maximum Length: 64

  The object for which rule condition needs to be created.
• ObjectAttributeCode: string
  Title: Object Attribute Code

  Maximum Length: 80

  The attribute for which rule condition needs to be created.
• Operator: string
  Title: Operator

  Maximum Length: 30

  The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.
• Value: string
  Title: Value

  Maximum Length: 255

  The value of condition.

{
    "type":"object",
    "properties":{
        "Object":{
            "title":"Object",
            "maxLength":64,
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":80,
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false
        },
        "Operator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.",
            "nullable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value of 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 : accessGroupRules-AccessGroupCondition-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date on which the group condition was created.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the group condition can be deleted.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the group condition was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 64

  The object for which rule condition needs to be created.
• ObjectAttributeCode: string
  Title: Object Attribute Code

  Maximum Length: 80

  The attribute for which rule condition needs to be created.
• ObjectAttributeName: string
  Title: Object Attribute Name

  Read Only: true

  The object attribute display name for which condition needs to be created.
• ObjectCode: string
  Title: Object Code

  Read Only: true

  Maximum Length: 75

  The object code for which rule condition needs to be created.
• Operator: string
  Title: Operator

  Maximum Length: 30

  The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.
• RuleConditionNumber: string
  Title: Rule Condition Number

  Maximum Length: 30

  The rule condition number.
• RuleNumber: string
  Title: Rule Number

  Read Only: true

  Maximum Length: 30

  The rule number for which condition needs to be created.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the group condition can be updated.
• Value: string
  Title: Value

  Maximum Length: 255

  The value of condition.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the group condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group condition 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 group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":64,
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":80,
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectAttributeName":{
            "title":"Object Attribute Name",
            "type":"string",
            "description":"The object attribute display name for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":75,
            "type":"string",
            "description":"The object code for which rule condition needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":30,
            "type":"string",
            "description":"The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleConditionNumber":{
            "title":"Rule Condition Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule condition number.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the group condition can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value of condition.",
            "nullable":true,
            "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