Jump to

• Request
• Response

Update a unit of measure

patch

/fscmRestApi/resources/11.13.18.05/publicSectorUnits/{UnitOfMeasure}

Request

Path Parameters

• UnitOfMeasure(required): string
  The unique identifier for a unit of measure.

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

• Description: string
  Title: Description

  Maximum Length: 30

  The description of the unit of measure.
• UomIsoCode: string
  Title: ISO Code

  Maximum Length: 2

  The ISO code for a unit of measure.
• UomType: string
  Title: Unit Type

  Maximum Length: 30

  The type of unit of measure, such as length, volume, or time.

{
    "type":"object",
    "properties":{
        "UomIsoCode":{
            "title":"ISO Code",
            "maxLength":"2",
            "type":"string",
            "description":"The ISO code for a unit of measure.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the unit of measure.",
            "nullable":false
        },
        "UomType":{
            "title":"Unit Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of unit of measure, such as length, volume, or time.",
            "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 : publicSectorUnits-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Maximum Length: 30

  The description of the unit of measure.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 5

  The unique identifier for a unit of measure.
• UomIsoCode: string
  Title: ISO Code

  Maximum Length: 2

  The ISO code for a unit of measure.
• UomType: string
  Title: Unit Type

  Maximum Length: 30

  The type of unit of measure, such as length, volume, or time.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UomIsoCode":{
            "title":"ISO Code",
            "maxLength":"2",
            "type":"string",
            "description":"The ISO code for a unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the unit of measure 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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"5",
            "type":"string",
            "description":"The unique identifier for a unit of measure.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UomType":{
            "title":"Unit Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of unit of measure, such as length, volume, or time.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the unit of measure 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