Jump to

• Request
• Response

Update one conformance parameter target value

patch

/fscmRestApi/resources/11.13.18.05/conformanceParameterTargetValues/{ConformanceParameterTargetValueId}

Request

Path Parameters

• ConformanceParameterTargetValueId(required): integer(int64)
  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=

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

• ConformanceParameterAssignmentId: integer (int64)
  Unique identifier of the conformance parameter.
• ConformanceParameterId: integer (int64)
  Unique identifier of the conformance parameter relationship.
• ConformanceParameterTargetValueId: integer (int64)
  Unque identifier of the conformance parameter target value.
• InventoryItemId: integer (int64)
  Description of the inventory item.
• MaximumValue: number
  Minimum acceptable value of the conformance parameter for this item.
• MinimumValue: number
  Record version number for locking.
• OrganizationId: integer (int64)
  Organization associated with the conformance parameter.
• TargetValue: number
  Target value of the conformance parameter.

{
    "type":"object",
    "properties":{
        "ConformanceParameterAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConformanceParameterId":{
            "type":"integer",
            "description":"Unique identifier of the conformance parameter relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ConformanceParameterTargetValueId":{
            "type":"integer",
            "description":"Unque identifier of the conformance parameter target value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Description of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MaximumValue":{
            "type":"number",
            "description":"Minimum acceptable value of the conformance parameter for this item.",
            "nullable":false
        },
        "MinimumValue":{
            "type":"number",
            "description":"Record version number for locking.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization associated with the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the conformance parameter.",
            "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 : conformanceParameterTargetValues-item-response

Type: object

Show Source

• CategoryId: integer
  Read Only: true

  Unique identifier of the inventory functional area category for which the conformance parameters are setup.
• CategoryName: string
  Read Only: true

  Maximum Length: 255

  Name of the inventory functional area category.
• ConformanceParameterAssignmentId: integer (int64)
  Unique identifier of the conformance parameter.
• ConformanceParameterId: integer (int64)
  Unique identifier of the conformance parameter relationship.
• ConformanceParameterTargetValueId: integer (int64)
  Unque identifier of the conformance parameter target value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time record was created.
• DataType: string
  Read Only: true

  Maximum Length: 255

  Data type of the conformance parameter.
• DataTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning of the data type.
• DecimalPrecision: integer (int64)
  Read Only: true

  Unique identifier of the item for which the conformance parameters are setup.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Flag that indicates whether the parameter is enabled.
• InventoryItemId: integer (int64)
  Description of the inventory item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Number to identify the inventory item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 255

  Date and time when the record was updated.
• LastUpdateDate: string (date-time)
  Read Only: true

  Login session used for the most recent update.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Maximum acceptable value of the conformance parameter for this item.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MaximumValue: number
  Minimum acceptable value of the conformance parameter for this item.
• MinimumValue: number
  Record version number for locking.
• OrganizationId: integer (int64)
  Organization associated with the conformance parameter.
• ParameterCode: string
  Read Only: true

  Maximum Length: 255

  Code of the conformance parameter.
• ParameterDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the conformance parameter.
• ParameterMaximumValue: number
  Read Only: true

  Maximum acceptable value of the conformance parameter at the organization level.
• ParameterMinimumValue: number
  Read Only: true

  Minimum acceptable value of the conformance parameter at the organization level.
• TargetValue: number
  Target value of the conformance parameter.
• UOMCode: string
  Read Only: true

  Maximum Length: 255

  Code for the UOM used in the conformance parameter.
• UOMMeaning: string
  Read Only: true

  Maximum Length: 255

  Meaning of the UOM.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Unique identifier of the inventory functional area category for which the conformance parameters are setup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the inventory functional area category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConformanceParameterAssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConformanceParameterId":{
            "type":"integer",
            "description":"Unique identifier of the conformance parameter relationship.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConformanceParameterTargetValueId":{
            "type":"integer",
            "description":"Unque identifier of the conformance parameter target value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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 record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "maxLength":255,
            "type":"string",
            "description":"Data type of the conformance parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the data type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DecimalPrecision":{
            "type":"integer",
            "description":"Unique identifier of the item for which the conformance parameters are setup.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag that indicates whether the parameter is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Description of the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Number to identify the inventory item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Date and time when the record was updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Login session used for the most recent update.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"User who updated the record most recently.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Maximum acceptable value of the conformance parameter for this item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumValue":{
            "type":"number",
            "description":"Minimum acceptable value of the conformance parameter for this item.",
            "nullable":false,
            "x-queryable":true
        },
        "MinimumValue":{
            "type":"number",
            "description":"Record version number for locking.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Organization associated with the conformance parameter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParameterCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the conformance parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the conformance parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterMaximumValue":{
            "type":"number",
            "description":"Maximum acceptable value of the conformance parameter at the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParameterMinimumValue":{
            "type":"number",
            "description":"Minimum acceptable value of the conformance parameter at the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetValue":{
            "type":"number",
            "description":"Target value of the conformance parameter.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code for the UOM used in the conformance parameter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the UOM.",
            "nullable":true,
            "readOnly":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