Jump to

• Request
• Response

Create RFID tag mappings

post

/fscmRestApi/resources/11.13.18.05/inventoryRFIDTagMappings

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

• DeletedFlag: boolean
  Maximum Length: 1

  Value that indicates if the tag is deleted.
• EnabledFlag: boolean
  Maximum Length: 1

  Value that indicates if the tag is active or inactive.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the Item.
• LinkedObjectType: string
  Maximum Length: 30

  Identifies the type of object mapped to RFID Tag.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• LotNumber: string
  Maximum Length: 80

  Lot number associated with the item.
• LPNId: integer (int64)
  Value that uniquely identifies the LPN.
• OrganizationId: integer (int64)
  Value that uniquely identify the Organization.
• SerialNumber: string
  Maximum Length: 80

  Serial number associated with the item.
• SubinventoryCode: string
  Maximum Length: 10

  Code that identifies the subinventory.
• TagCode: string
  Maximum Length: 64

  A user-defined code for the RFID tag mapping.
• TagId: integer (int64)
  Value that uniquely identify the RFID tag mapping.
• TagTypeCode: string
  Maximum Length: 1

  Value that identifies the type of the tag.
• UOMCode: string
  Maximum Length: 3

  UOM code of the item.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the tag is deleted.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the tag is active or inactive.",
            "nullable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LinkedObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of object mapped to RFID Tag.",
            "nullable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number associated with the item.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identify the Organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number associated with the item.",
            "nullable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the subinventory.",
            "nullable":true
        },
        "TagCode":{
            "maxLength":64,
            "type":"string",
            "description":"A user-defined code for the RFID tag mapping.",
            "nullable":false
        },
        "TagId":{
            "type":"integer",
            "description":"Value that uniquely identify the RFID tag mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "TagTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the type of the tag.",
            "nullable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"UOM code of the item.",
            "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 : inventoryRFIDTagMappings-item-response

Type: object

Show Source

• DeletedFlag: boolean
  Maximum Length: 1

  Value that indicates if the tag is deleted.
• EnabledFlag: boolean
  Maximum Length: 1

  Value that indicates if the tag is active or inactive.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the Item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number of the item.
• LicensePlateNumber: string
  Title: Packing Unit

  Read Only: true

  Maximum Length: 30

  Name of the LPN.
• LinkedObjectType: string
  Maximum Length: 30

  Identifies the type of object mapped to RFID Tag.
• LinkedObjectTypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  A name for the linked object type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• LocatorName: string
  Read Only: true

  Maximum Length: 4000

  Name of the locator.
• LotNumber: string
  Maximum Length: 80

  Lot number associated with the item.
• LPNId: integer (int64)
  Value that uniquely identifies the LPN.
• OrganizationId: integer (int64)
  Value that uniquely identify the Organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization.
• SerialNumber: string
  Maximum Length: 80

  Serial number associated with the item.
• SubinventoryCode: string
  Maximum Length: 10

  Code that identifies the subinventory.
• TagCode: string
  Maximum Length: 64

  A user-defined code for the RFID tag mapping.
• TagId: integer (int64)
  Value that uniquely identify the RFID tag mapping.
• TagTypeCode: string
  Maximum Length: 1

  Value that identifies the type of the tag.
• UOMCode: string
  Maximum Length: 3

  UOM code of the item.

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the tag is deleted.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the tag is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the Item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LPNId":{
            "type":"integer",
            "description":"Value that uniquely identifies the LPN.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LicensePlateNumber":{
            "title":"Packing Unit",
            "maxLength":30,
            "type":"string",
            "description":"Name of the LPN.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkedObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the type of object mapped to RFID Tag.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkedObjectTypeMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"A name for the linked object type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Lot number associated with the item.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identify the Organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Serial number associated with the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "maxLength":10,
            "type":"string",
            "description":"Code that identifies the subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "TagCode":{
            "maxLength":64,
            "type":"string",
            "description":"A user-defined code for the RFID tag mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "TagId":{
            "type":"integer",
            "description":"Value that uniquely identify the RFID tag mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the type of the tag.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"UOM code of the item.",
            "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