Jump to

• Request
• Response

Create one lot specific conversion

post

/fscmRestApi/resources/11.13.18.05/lotUnitOfMeasureConversions

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConversionFactor: number
  The rate of conversion between the primary and secondary unit of measure classes for the item assigned to the inventory lot.
• EndDatetime: string (date-time)
  The end date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the same value as the start date and time.
• InventoryItemId: integer (int64)
  The value that uniquely identifies the inventory item specifying the lot specific conversion.
• InverseConversionFactor: number
  The value that will be inverted to find the unit conversion rate.
• InverseConversionFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.
• ItemDescription: string
  Maximum Length: 80

  The user-supplied description of the inventory item specifying the lot-specific conversion.
• ItemNumber: string
  Maximum Length: 80

  The user-supplied name of the inventory item specifying the lot-specific conversion.
• LotConversionId: integer (int64)
  The value that uniquely identifies the lot specific conversion. This attribute is the primary key and is system generated.
• LotNumber: string
  Maximum Length: 80

  The value that uniquely identifies the lot specifying the lot specific conversion.
• OrganizationCode: string
  Maximum Length: 255

  The user supplied short code that uniquely identifies the inventory organization specifying the lot specific conversion.
• OrganizationId: integer (int64)
  The value that uniquely identifies the inventory organization specifying the lot specific conversion.
• OrganizationName: string
  Maximum Length: 80

  The user-supplied name of the inventory organization specifying the lot-specific conversion.
• PrimaryUOMBaseCode: string
  Maximum Length: 3

  The user supplied short code of the base unit in the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMBaseName: string
  Maximum Length: 255

  The user supplied name of the base unit in the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMClassCode: string
  Maximum Length: 10

  The user supplied short code of the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMClassName: string
  Maximum Length: 255

  The user supplied name of the class of the primary unit of measure for the item assigned to the lot.
• ReasonId: integer (int64)
  The value that uniquely identifies the transaction reason linked to the update of the lot-specific conversion.
• ReasonName: string
  Maximum Length: 80

  The user-supplied name of the transaction reason associated with the update of the lot-specific conversion.
• StartDatetime: string (date-time)
  The start date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the system date and time as the start date and time.
• TransactionUOMBaseCode: string
  Maximum Length: 3

  The user supplied short code of the base unit in the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMBaseName: string
  Maximum Length: 255

  The user supplied name of the base unit in the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMClassCode: string
  Maximum Length: 10

  The user supplied short code of the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMClassName: string
  Maximum Length: 255

  The user supplied name of the class of the secondary unit of measure for the item assigned to the lot.

{
    "type":"object",
    "properties":{
        "ConversionFactor":{
            "type":"number",
            "description":"The rate of conversion between the primary and secondary unit of measure classes for the item assigned to the inventory lot.",
            "nullable":false
        },
        "EndDatetime":{
            "type":"string",
            "description":"The end date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the same value as the start date and time.",
            "format":"date-time",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory item specifying the lot specific conversion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InverseConversionFactor":{
            "type":"number",
            "description":"The value that will be inverted to find the unit conversion rate.",
            "nullable":true
        },
        "InverseConversionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.",
            "nullable":true
        },
        "ItemDescription":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied description of the inventory item specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the inventory item specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "LotConversionId":{
            "type":"integer",
            "description":"The value that uniquely identifies the lot specific conversion. This attribute is the primary key and is system generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The value that uniquely identifies the lot specifying the lot specific conversion.",
            "nullable":false
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied short code that uniquely identifies the inventory organization specifying the lot specific conversion.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization specifying the lot specific conversion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationName":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the inventory organization specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryUOMBaseCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user supplied short code of the base unit in the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":false
        },
        "PrimaryUOMBaseName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the base unit in the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true
        },
        "PrimaryUOMClassCode":{
            "maxLength":10,
            "type":"string",
            "description":"The user supplied short code of the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true
        },
        "PrimaryUOMClassName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true
        },
        "ReasonId":{
            "type":"integer",
            "description":"The value that uniquely identifies the transaction reason linked to the update of the lot-specific conversion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReasonName":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the transaction reason associated with the update of the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDatetime":{
            "type":"string",
            "description":"The start date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the system date and time as the start date and time.",
            "format":"date-time",
            "nullable":true
        },
        "TransactionUOMBaseCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user supplied short code of the base unit in the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":false
        },
        "TransactionUOMBaseName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the base unit in the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":true
        },
        "TransactionUOMClassCode":{
            "maxLength":10,
            "type":"string",
            "description":"The user supplied short code of the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":true
        },
        "TransactionUOMClassName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the class of the secondary unit of measure for the item assigned to the lot.",
            "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 : lotUnitOfMeasureConversions-item-response

Type: object

Show Source

• ConversionFactor: number
  The rate of conversion between the primary and secondary unit of measure classes for the item assigned to the inventory lot.
• EndDatetime: string (date-time)
  The end date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the same value as the start date and time.
• InventoryItemId: integer (int64)
  The value that uniquely identifies the inventory item specifying the lot specific conversion.
• InverseConversionFactor: number
  The value that will be inverted to find the unit conversion rate.
• InverseConversionFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.
• ItemDescription: string
  Maximum Length: 80

  The user-supplied description of the inventory item specifying the lot-specific conversion.
• ItemNumber: string
  Maximum Length: 80

  The user-supplied name of the inventory item specifying the lot-specific conversion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotConversionId: integer (int64)
  The value that uniquely identifies the lot specific conversion. This attribute is the primary key and is system generated.
• LotNumber: string
  Maximum Length: 80

  The value that uniquely identifies the lot specifying the lot specific conversion.
• OrganizationCode: string
  Maximum Length: 255

  The user supplied short code that uniquely identifies the inventory organization specifying the lot specific conversion.
• OrganizationId: integer (int64)
  The value that uniquely identifies the inventory organization specifying the lot specific conversion.
• OrganizationName: string
  Maximum Length: 80

  The user-supplied name of the inventory organization specifying the lot-specific conversion.
• PrimaryUOMBaseCode: string
  Maximum Length: 3

  The user supplied short code of the base unit in the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMBaseName: string
  Maximum Length: 255

  The user supplied name of the base unit in the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMClassCode: string
  Maximum Length: 10

  The user supplied short code of the class of the primary unit of measure for the item assigned to the lot.
• PrimaryUOMClassName: string
  Maximum Length: 255

  The user supplied name of the class of the primary unit of measure for the item assigned to the lot.
• ReasonId: integer (int64)
  The value that uniquely identifies the transaction reason linked to the update of the lot-specific conversion.
• ReasonName: string
  Maximum Length: 80

  The user-supplied name of the transaction reason associated with the update of the lot-specific conversion.
• StartDatetime: string (date-time)
  The start date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the system date and time as the start date and time.
• TransactionUOMBaseCode: string
  Maximum Length: 3

  The user supplied short code of the base unit in the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMBaseName: string
  Maximum Length: 255

  The user supplied name of the base unit in the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMClassCode: string
  Maximum Length: 10

  The user supplied short code of the class of the secondary unit of measure for the item assigned to the lot.
• TransactionUOMClassName: string
  Maximum Length: 255

  The user supplied name of the class of the secondary unit of measure for the item assigned to the lot.

{
    "type":"object",
    "properties":{
        "ConversionFactor":{
            "type":"number",
            "description":"The rate of conversion between the primary and secondary unit of measure classes for the item assigned to the inventory lot.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDatetime":{
            "type":"string",
            "description":"The end date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the same value as the start date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory item specifying the lot specific conversion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InverseConversionFactor":{
            "type":"number",
            "description":"The value that will be inverted to find the unit conversion rate.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseConversionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied description of the inventory item specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the inventory item specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "LotConversionId":{
            "type":"integer",
            "description":"The value that uniquely identifies the lot specific conversion. This attribute is the primary key and is system generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"The value that uniquely identifies the lot specifying the lot specific conversion.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied short code that uniquely identifies the inventory organization specifying the lot specific conversion.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization specifying the lot specific conversion.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the inventory organization specifying the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryUOMBaseCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user supplied short code of the base unit in the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryUOMBaseName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the base unit in the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMClassCode":{
            "maxLength":10,
            "type":"string",
            "description":"The user supplied short code of the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMClassName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the class of the primary unit of measure for the item assigned to the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonId":{
            "type":"integer",
            "description":"The value that uniquely identifies the transaction reason linked to the update of the lot-specific conversion.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReasonName":{
            "maxLength":80,
            "type":"string",
            "description":"The user-supplied name of the transaction reason associated with the update of the lot-specific conversion.",
            "nullable":true,
            "x-queryable":false
        },
        "StartDatetime":{
            "type":"string",
            "description":"The start date and time of this lot conversion factor. Each update of the conversion factor will end date the current definition and generate a new conversion with the system date and time as the start date and time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOMBaseCode":{
            "maxLength":3,
            "type":"string",
            "description":"The user supplied short code of the base unit in the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionUOMBaseName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the base unit in the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOMClassCode":{
            "maxLength":10,
            "type":"string",
            "description":"The user supplied short code of the class of the secondary unit of measure for the item assigned to the lot.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUOMClassName":{
            "maxLength":255,
            "type":"string",
            "description":"The user supplied name of the class of the secondary unit of measure for the item assigned to the lot.",
            "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