Jump to

• Request
• Response
• Examples

Create one intraclass conversion

post

/fscmRestApi/resources/11.13.18.05/unitsOfMeasure/{UOMCode}/child/intraclassConversions

Request

Path Parameters

• UOMCode(required): string
  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=

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

• IntraclassConversion: number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.
• IntraclassConversionEndDate: string (date)
  Title: End Date

  Date when the unit of measure intraclass conversion is no longer available.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.
• InverseConversionFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.
• InverseConversionRate: number
  The value that will be inverted to find the unit conversion rate.

{
    "type":"object",
    "properties":{
        "IntraclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.",
            "nullable":false
        },
        "IntraclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure intraclass conversion is no longer available.",
            "format":"date",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InverseConversionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.",
            "nullable":true
        },
        "InverseConversionRate":{
            "type":"number",
            "description":"The value that will be inverted to find the unit conversion rate.",
            "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 : unitsOfMeasure-intraclassConversions-item-response

Type: object

Show Source

• ConversionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the unit of measure intraclass conversion. It's a value that the application generates when it creates a unit. This attribute is required.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date and time when the user created the record.
• IntraclassConversion: number
  Title: Conversion

  Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.
• IntraclassConversionEndDate: string (date)
  Title: End Date

  Date when the unit of measure intraclass conversion is no longer available.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.
• InverseConversionFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.
• InverseConversionRate: number
  The value that will be inverted to find the unit conversion rate.
• ItemNumber: string
  Read Only: true

  Alphanumeric name that uniquely identifies the item that the intraclass conversion is being defined for. Either this attribute or InventoryItemId is required.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ConversionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the unit of measure intraclass conversion. It's a value that the application generates when it creates a unit. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntraclassConversion":{
            "title":"Conversion",
            "type":"number",
            "description":"Rate of conversion between the unit of measure and the base unit of the class for the specified inventory item. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "IntraclassConversionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the unit of measure intraclass conversion is no longer available.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item that the intraclass conversion is being defined for. This attribute is required.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InverseConversionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the conversion rate between the secondary unit of the class and the base UOM of the class is modeled as an inverse quantity. In this case, the conversion factor represents the amount of secondary unit that equals one unit of the base unit. If false, the conversion factor represents one unit of the secondary unit converted to the corresponding amount of the base unit. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "InverseConversionRate":{
            "type":"number",
            "description":"The value that will be inverted to find the unit conversion rate.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Alphanumeric name that uniquely identifies the item that the intraclass conversion is being defined for. Either this attribute or InventoryItemId is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":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

Examples

This example describes how to create one intraclass conversion.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/unitsOfMeasure/UOMCode/child/intraclassConversions"

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.

Authorization: user/password
Content Type: application/json 
Operation: POST 
{
   "InventoryItemId" : 100000012013473, 
   "IntraclassConversion" : 13, 
   "IntraclassConversionEndDate" : null, 
}

Example Response Body

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

{ 
  "InventoryItemId" : 100000012013473, 
  "ConversionId" : 300100132310571, 
  "IntraclassConversion" : 13, 
  "IntraclassConversionEndDate" : null, 
  "ItemNumber" : "ZCST-Plain-Asset1", 
  "links" : [ { 
  ...
  } ] 
}

Back to Top