Jump to

• Request
• Response

Update one matrix type

patch

/fscmRestApi/resources/11.13.18.05/pricingMatrixTypes/{pricingMatrixTypesUniqID}

Request

Path Parameters

• pricingMatrixTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Pricing Matrix Types resource and used to uniquely identify an instance of Pricing Matrix Types. The client should not generate the hash key value. Instead, the client should query on the Pricing Matrix Types collection resource in order to navigate to a specific instance of Pricing Matrix Types to get the hash key.

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

• Active: string
  Title: Active

  Maximum Length: 30

  Default Value: N

  Contains one of the following values. Y: pricing matrix type is active. N: pricing matrix type is inactive. This attribute doesn't have a default value.
• AllowMultipleMatrixes: string
  Title: Allow Multiple Matrixes

  Maximum Length: 30

  Default Value: N

  Contains one of the following values. Y: pricing matrix type allows for multiple matrixes. N: pricing matrix type doesn't allow for multiple matrixes. This attribute doesn't have a default value.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the matrix type.
• MatrixClassId: integer (int64)
  Title: Dynamic Matrix Class

  Value that uniquely identifies the matrix class for the matrix type.
• Name: string
  Title: Name

  Maximum Length: 80

  Name of the pricing matrix type.
• PricingMatrixId: integer (int64)
  Value that uniquely identifies the matrix.

{
    "type":"object",
    "properties":{
        "Active":{
            "title":"Active",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values. Y: pricing matrix type is active. N: pricing matrix type is inactive. This attribute doesn't have a default value.",
            "nullable":false,
            "default":"N"
        },
        "AllowMultipleMatrixes":{
            "title":"Allow Multiple Matrixes",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values. Y: pricing matrix type allows for multiple matrixes. N: pricing matrix type doesn't allow for multiple matrixes. This attribute doesn't have a default value.",
            "nullable":false,
            "default":"N"
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the matrix type.",
            "nullable":true
        },
        "MatrixClassId":{
            "title":"Dynamic Matrix Class",
            "type":"integer",
            "description":"Value that uniquely identifies the matrix class for the matrix type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the pricing matrix type.",
            "nullable":false
        },
        "PricingMatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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 : pricingMatrixTypes-item-response

Type: object

Show Source

• Active: string
  Title: Active

  Maximum Length: 30

  Default Value: N

  Contains one of the following values. Y: pricing matrix type is active. N: pricing matrix type is inactive. This attribute doesn't have a default value.
• AllowMultipleMatrixes: string
  Title: Allow Multiple Matrixes

  Maximum Length: 30

  Default Value: N

  Contains one of the following values. Y: pricing matrix type allows for multiple matrixes. N: pricing matrix type doesn't allow for multiple matrixes. This attribute doesn't have a default value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 1000

  Description of the matrix type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Most recent date and time when the application updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixClassId: integer (int64)
  Title: Dynamic Matrix Class

  Value that uniquely identifies the matrix class for the matrix type.
• MatrixClassName: string
  Read Only: true

  Maximum Length: 255

  Name of the pricing matrix class.
• MatrixTypeCode: string
  Title: Matrix Type Code

  Maximum Length: 30

  Abbreviation that identifies the type for a matrix class.
• MatrixTypeId: integer (int64)
  Value that uniquely identifies the matrix type.
• Name: string
  Title: Name

  Maximum Length: 80

  Name of the pricing matrix type.
• PricingMatrixId: integer (int64)
  Value that uniquely identifies the matrix.

{
    "type":"object",
    "properties":{
        "Active":{
            "title":"Active",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values. Y: pricing matrix type is active. N: pricing matrix type is inactive. This attribute doesn't have a default value.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "AllowMultipleMatrixes":{
            "title":"Allow Multiple Matrixes",
            "maxLength":30,
            "type":"string",
            "description":"Contains one of the following values. Y: pricing matrix type allows for multiple matrixes. N: pricing matrix type doesn't allow for multiple matrixes. This attribute doesn't have a default value.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"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":"Description of the matrix type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Most recent date and time when the application updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixClassId":{
            "title":"Dynamic Matrix Class",
            "type":"integer",
            "description":"Value that uniquely identifies the matrix class for the matrix type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MatrixClassName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the pricing matrix class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixTypeCode":{
            "title":"Matrix Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type for a matrix class.",
            "nullable":false,
            "x-queryable":true
        },
        "MatrixTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the pricing matrix type.",
            "nullable":false,
            "x-queryable":true
        },
        "PricingMatrixId":{
            "type":"integer",
            "description":"Value that uniquely identifies the matrix.",
            "format":"int64",
            "nullable":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