Jump to

• Request
• Response

Update a use case selected field

patch

/crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}

Request

Path Parameters

• UsecaseCode(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ZcaOmlUsecaseFixedFieldsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- FieldName and UsecaseCode ---for the Use Case Selected Fields resource and used to uniquely identify an instance of Use Case Selected Fields. The client should not generate the hash key value. Instead, the client should query on the Use Case Selected Fields collection resource with a filter on the primary key values in order to navigate to a specific instance of Use Case Selected Fields.
  
  For example: ZcaOmlUsecaseFixedFields?q=FieldName=<value1>;UsecaseCode=<value2>

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

• AdditionalMetadata: string (byte)
  The object version number for the record.
• FieldDataType: string
  Maximum Length: 200

  The data type of the field such as string, boolean, and so on.
• FieldName: string
  Maximum Length: 800

  The display name of the available field.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• UsecaseCode: string
  Maximum Length: 200

  The unique identifier of the use case used to find a use case.

{
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The data type of the field such as string, boolean, and so on.",
            "nullable":false
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false
        }
    }
}

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 : salesMLUsecases-ZcaOmlUsecaseFixedFields-item-response

Type: object

Show Source

• AdditionalMetadata: string (byte)
  The object version number for the record.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• FieldDataType: string
  Maximum Length: 200

  The data type of the field such as string, boolean, and so on.
• FieldName: string
  Maximum Length: 800

  The display name of the available field.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the model record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the model.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the model.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number for the record.
• UsecaseCode: string
  Maximum Length: 200

  The unique identifier of the use case used to find a use case.

{
    "type":"object",
    "properties":{
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The data type of the field such as string, boolean, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "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