Jump to

• Request
• Response
• Examples

Generate serial numbers

post

/fscmRestApi/resources/11.13.18.05/generateSerialNumbers

Request

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EndSerialNumber: string
  Ending serial number in the range of serial numbers to create.
• InventoryItemId: integer
  Value that uniquely identifies the inventory item.
• ItemNumber: string
  Name of the inventory item.
• NumberOfSerials: integer
  Number of serial numbers to create.
• OrganizationCode: string
  Abbreviation that identifies the organization.
• OrganizationId: string
  Value that uniquely identifies the organization.
• ReturnMessageName: string
  Name of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnMessageText: string
  Text of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnStatus: string
  Status of the request to create serial numbers.
• StartSerialNumber: string
  Starting serial number in the range of serial numbers to create.

{
    "type":"object",
    "properties":{
        "EndSerialNumber":{
            "type":"string",
            "description":"Ending serial number in the range of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "NumberOfSerials":{
            "type":"integer",
            "description":"Number of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "StartSerialNumber":{
            "type":"string",
            "description":"Starting serial number in the range of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of the request to create serial numbers.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Name of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Text of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":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 : generateSerialNumbers-item-response

Type: object

Show Source

• EndSerialNumber: string
  Ending serial number in the range of serial numbers to create.
• InventoryItemId: integer
  Value that uniquely identifies the inventory item.
• ItemNumber: string
  Name of the inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfSerials: integer
  Number of serial numbers to create.
• OrganizationCode: string
  Abbreviation that identifies the organization.
• OrganizationId: string
  Value that uniquely identifies the organization.
• ReturnMessageName: string
  Name of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnMessageText: string
  Text of the error message when the request fails. If the request is successful, then this attribute value is empty.
• ReturnStatus: string
  Status of the request to create serial numbers.
• StartSerialNumber: string
  Starting serial number in the range of serial numbers to create.

{
    "type":"object",
    "properties":{
        "EndSerialNumber":{
            "type":"string",
            "description":"Ending serial number in the range of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "NumberOfSerials":{
            "type":"integer",
            "description":"Number of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "type":"string",
            "description":"Name of the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "StartSerialNumber":{
            "type":"string",
            "description":"Starting serial number in the range of serial numbers to create.",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnStatus":{
            "type":"string",
            "description":"Status of the request to create serial numbers.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageName":{
            "type":"string",
            "description":"Name of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        },
        "ReturnMessageText":{
            "type":"string",
            "description":"Text of the error message when the request fails. If the request is successful, then this attribute value is empty.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Examples

This example describes how to create a serial number.

Example cURL Command

Use the following cURL command to submit a request on the REST resource. This example creates a serial number for inventory item 663959 in organization 207:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/generateSerialNumbers?onlyData=true"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "OrganizationId" : 207,
  "InventoryItemId" : 663959,
  "NumberOfSerials" : 3
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
  "OrganizationCode" : null,
  "OrganizationId" : "207",
  "ItemNumber" : null,
  "InventoryItemId" : 663959,
  "NumberOfSerials" : 3,
  "StartSerialNumber" : "SS0210",
  "EndSerialNumber" : "SS0212",
  "ReturnStatus" : "SUCCESS",
  "ReturnMessageName" : null,
  "ReturnMessageText" : null
}

Back to Top