Jump to

• Request
• Response

Update a product group usage

patch

/crmRestApi/resources/11.13.18.05/productGroupUsages/{UsageCode}/child/ProductGroupUsageEngine/{ProductGroupUsageEngineUniqID}

Request

Path Parameters

• ProductGroupUsageEngineUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Product Group Usage Functions resource and used to uniquely identify an instance of Product Group Usage Functions. The client should not generate the hash key value. Instead, the client should query on the Product Group Usage Functions collection resource in order to navigate to a specific instance of Product Group Usage Functions to get the hash key.
• UsageCode(required): string
  The usage code of the product group.

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

• UsageCode: string
  Maximum Length: 30

  The usage code of the usage engine.
• UsageModeCode: string
  Title: Mode

  Maximum Length: 30

  The usage mode code of the usage engine.
• UsagePrefCode: string
  Title: Name

  Maximum Length: 30

  The usage preference code of the usage engine.
• UsagePrefValue: string
  Title: Value

  Maximum Length: 100

  The usage preference value of the usage engine.

{
    "type":"object",
    "properties":{
        "UsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of the usage engine.",
            "nullable":false
        },
        "UsageModeCode":{
            "title":"Mode",
            "maxLength":30,
            "type":"string",
            "description":"The usage mode code of the usage engine.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "UsagePrefCode"
                ]
            }
        },
        "UsagePrefCode":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The usage preference code of the usage engine.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UsagePrefValue":{
            "title":"Value",
            "maxLength":100,
            "type":"string",
            "description":"The usage preference value of the usage engine.",
            "nullable":true,
            "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 : productGroupUsages-ProductGroupUsageEngine-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the usage engine record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• UsageCode: string
  Maximum Length: 30

  The usage code of the usage engine.
• UsageModeCode: string
  Title: Mode

  Maximum Length: 30

  The usage mode code of the usage engine.
• UsagePrefCode: string
  Title: Name

  Maximum Length: 30

  The usage preference code of the usage engine.
• UsagePrefValue: string
  Title: Value

  Maximum Length: 100

  The usage preference value of the usage engine.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage engine record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the usage engine record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the usage engine record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the usage engine record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The usage code of the usage engine.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageModeCode":{
            "title":"Mode",
            "maxLength":30,
            "type":"string",
            "description":"The usage mode code of the usage engine.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "UsagePrefCode"
                ]
            },
            "x-queryable":true
        },
        "UsagePrefCode":{
            "title":"Name",
            "maxLength":30,
            "type":"string",
            "description":"The usage preference code of the usage engine.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UsagePrefValue":{
            "title":"Value",
            "maxLength":100,
            "type":"string",
            "description":"The usage preference value of the usage engine.",
            "nullable":true,
            "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"
            }
        }
    }
}

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