Jump to

• Request
• Response

Update a serial range

patch

/fscmRestApi/resources/11.13.18.05/inventoryReservations/{ReservationId}/child/serialRanges/{serialRangesUniqID}

Request

Path Parameters

• ReservationId(required): integer(int64)
  Value that uniquely identifies the reservation.
• serialRangesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Serial Ranges resource and used to uniquely identify an instance of Serial Ranges. The client should not generate the hash key value. Instead, the client should query on the Serial Ranges collection resource in order to navigate to a specific instance of Serial Ranges to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• FromSerial: string
  Maximum Length: 80

  Start of the serial number range for the reservation of an item.
• ToSerial: string
  Maximum Length: 80

  End of the serial number range for the reservation of an item.

{
    "type":"object",
    "properties":{
        "FromSerial":{
            "maxLength":80,
            "type":"string",
            "description":"Start of the serial number range for the reservation of an item.",
            "nullable":false
        },
        "ToSerial":{
            "maxLength":80,
            "type":"string",
            "description":"End of the serial number range for the reservation of an 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 : inventoryReservations-serialRanges-item-response

Type: object

Show Source

• FromSerial: string
  Maximum Length: 80

  Start of the serial number range for the reservation of an item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Read Only: true

  Total number of serials present in a serial range.
• SupplierSerialNumber: string
  Read Only: true

  Supplier serial number corresponding to a serial number.
• ToSerial: string
  Maximum Length: 80

  End of the serial number range for the reservation of an item.

{
    "type":"object",
    "properties":{
        "FromSerial":{
            "maxLength":80,
            "type":"string",
            "description":"Start of the serial number range for the reservation of an item.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Total number of serials present in a serial range.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ToSerial":{
            "maxLength":80,
            "type":"string",
            "description":"End of the serial number range for the reservation of an item.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSerialNumber":{
            "type":"string",
            "description":"Supplier serial number corresponding to a serial number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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