Jump to

• Request
• Response

Get one conversion record

get

/fscmRestApi/resources/11.13.18.05/onHandLotUOMConvRecords/{onHandLotUOMConvRecordsUniqID}

Request

Path Parameters

• onHandLotUOMConvRecordsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LotConversionId and OnhandConvHistoryId ---for the On Hand Lot Unit of Measure Conversion Records resource and used to uniquely identify an instance of On Hand Lot Unit of Measure Conversion Records. The client should not generate the hash key value. Instead, the client should query on the On Hand Lot Unit of Measure Conversion Records collection resource with a filter on the primary key values in order to navigate to a specific instance of On Hand Lot Unit of Measure Conversion Records.
  
  For example: onHandLotUOMConvRecords?q=LotConversionId=<value1>;OnhandConvHistoryId=<value2>

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

Type: object

Show Source

• CountryOfOrigin: string
  Maximum Length: 3

  Value that uniquely identifies the country of origin code.
• CountryOfOriginName: string
  Maximum Length: 80

  Value that uniquely identifies the country of origin name.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the record was created.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last update date of the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the record.
• LicensePlateNumber: string
  Title: Packing Unit

  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the license plate.
• LicensePlateNumberId: number
  Value that uniquely identifies the license plate number.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorId: number
  Value that uniquely identifies the locator.
• LocatorName: string
  Maximum Length: 80

  Name of the locator.
• LotConversionId: integer (int64)
  Value that uniquely identifies the lot conversion record.
• LotNumber: string
  Maximum Length: 80

  Value that uniquely identifies the lot number.
• NewPrimaryQuantity: number
  New lot primary quantity from the latest lot-specific UOM conversion rate.
• NewSecondaryQuantity: number
  New lot secondary quantity from the latest lot-specific UOM conversion rate.
• OldPrimaryQuantity: number
  The lot's primary quantity before the latest lot-specific UOM conversion rate.
• OldSecondaryQuantity: number
  The lot's secondary quantity before the latest lot-specific UOM conversion rate.
• OnhandConvHistoryId: integer
  Value that uniquely identifies the on-hand conversion history record.
• OnhandUpdateType: number
  Value that represents the on-hand update type.
• OnhandUpdateTypeMeaning: string
  Maximum Length: 80

  Value that represents the on-hand update type.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization.
• OwningEntityId: integer
  Value that uniquely identifies the entity that holds ownership of the on-hand material.
• ProjectId: number
  Value that uniquely identifies the project.
• ProjectNumber: string
  Maximum Length: 80

  Value that specifies the project number.
• Revision: string
  Maximum Length: 3

  Value that specifies the revision of the item.
• SubinventoryCode: string
  Maximum Length: 10

  Value that specifies the subinventory code.
• SubinventoryName: string
  Maximum Length: 80

  Value that specifies the subinventory code.
• SupplierName: string
  Maximum Length: 80

  Name of the supplier.
• SupplierSite: string
  Maximum Length: 80

  Site of the supplier.
• TaskId: number
  Value that uniquely identifies the task.
• TaskNumber: string
  Maximum Length: 80

  Value that specifies the task number.
• TransactionPrimaryQuantity: number
  Value that represents the transaction's primary quantity.
• TransactionSecondaryQuantity: number
  Value that represents the transaction secondary quantity.
• TransactionUpdateControl: string
  Maximum Length: 2

  Value that indicates whether the transaction has been updated.

{
    "type":"object",
    "properties":{
        "CountryOfOrigin":{
            "maxLength":3,
            "type":"string",
            "description":"Value that uniquely identifies the country of origin code.",
            "nullable":true,
            "x-queryable":true
        },
        "CountryOfOriginName":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the country of origin name.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last update date of the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePlateNumber":{
            "title":"Packing Unit",
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the license plate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePlateNumberId":{
            "type":"number",
            "description":"Value that uniquely identifies the license plate number.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"number",
            "description":"Value that uniquely identifies the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "x-queryable":false
        },
        "LotConversionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lot conversion record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the lot number.",
            "nullable":false,
            "x-queryable":true
        },
        "NewPrimaryQuantity":{
            "type":"number",
            "description":"New lot primary quantity from the latest lot-specific UOM conversion rate.",
            "nullable":true,
            "x-queryable":true
        },
        "NewSecondaryQuantity":{
            "type":"number",
            "description":"New lot secondary quantity from the latest lot-specific UOM conversion rate.",
            "nullable":true,
            "x-queryable":true
        },
        "OldPrimaryQuantity":{
            "type":"number",
            "description":"The lot's primary quantity before the latest lot-specific UOM conversion rate.",
            "nullable":false,
            "x-queryable":true
        },
        "OldSecondaryQuantity":{
            "type":"number",
            "description":"The lot's secondary quantity before the latest lot-specific UOM conversion rate.",
            "nullable":true,
            "x-queryable":true
        },
        "OnhandConvHistoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the on-hand conversion history record.",
            "nullable":false,
            "x-queryable":true
        },
        "OnhandUpdateType":{
            "type":"number",
            "description":"Value that represents the on-hand update type.",
            "nullable":true,
            "x-queryable":true
        },
        "OnhandUpdateTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Value that represents the on-hand update type.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the entity that holds ownership of the on-hand material.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "type":"number",
            "description":"Value that uniquely identifies the project.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that specifies the project number.",
            "nullable":true,
            "x-queryable":false
        },
        "Revision":{
            "maxLength":3,
            "type":"string",
            "description":"Value that specifies the revision of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Value that specifies the subinventory code.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryName":{
            "maxLength":80,
            "type":"string",
            "description":"Value that specifies the subinventory code.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "maxLength":80,
            "type":"string",
            "description":"Site of the supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskId":{
            "type":"number",
            "description":"Value that uniquely identifies the task.",
            "nullable":true,
            "x-queryable":true
        },
        "TaskNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Value that specifies the task number.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionPrimaryQuantity":{
            "type":"number",
            "description":"Value that represents the transaction's primary quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSecondaryQuantity":{
            "type":"number",
            "description":"Value that represents the transaction secondary quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionUpdateControl":{
            "maxLength":2,
            "type":"string",
            "description":"Value that indicates whether the transaction has been updated.",
            "nullable":false,
            "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