Jump to

• Request
• Response

Update a unit of measure conversion rate

patch

/fscmRestApi/resources/11.13.18.05/publicSectorUnitsConversions/{publicSectorUnitsConversionsUniqID}

Request

Path Parameters

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

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

• ConversionRate: number
  Title: Conversion Rate

  The conversion factor used to convert the original unit of measure to the target unit of measure.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the conversion rate is active. If the value is Y, the rate is active.

{
    "type":"object",
    "properties":{
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion factor used to convert the original unit of measure to the target unit of measure.",
            "nullable":false,
            "x-hints":{
                "precision":15,
                "scale":8
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the conversion rate is active. If the value is Y, the rate is active.",
            "nullable":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 : publicSectorUnitsConversions-item-response

Type: object

Show Source

• ConversionRate: number
  Title: Conversion Rate

  The conversion factor used to convert the original unit of measure to the target unit of measure.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the unit of measure conversion.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the unit of measure conversion was created.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the conversion rate is active. If the value is Y, the rate is active.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the unit of measure conversion was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the unit of measure conversion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UnitOfMeasure: string
  Title: UOM

  Maximum Length: 5

  The unique identifier of the starting unit of measure.
• UnitOfMeasureTo: string
  Title: UOM To

  Maximum Length: 5

  The unique identifier of the target unit of measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the unit of measure conversion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the unit of measure conversion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the unit of measure conversion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM",
            "maxLength":5,
            "type":"string",
            "description":"The unique identifier of the starting unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"The conversion factor used to convert the original unit of measure to the target unit of measure.",
            "nullable":false,
            "x-hints":{
                "precision":15,
                "scale":8
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UnitOfMeasureTo":{
            "title":"UOM To",
            "maxLength":5,
            "type":"string",
            "description":"The unique identifier of the target unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the conversion rate is active. If the value is Y, the rate is active.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the unit of measure conversion was last updated.",
            "format":"date-time",
            "nullable":false,
            "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