Jump to

• Request
• Response

Get one lot specific conversion

get

/fscmRestApi/resources/11.13.18.05/lotUnitOfMeasureConversions/{LotConversionId}

Request

Path Parameters

• LotConversionId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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.
• 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
        },
        "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