Jump to

• Request
• Response

Update a Units of Measure

put

/api/restapi/unitsOfMeasure

Send a request to this endpoint to update a unit of measure.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityUnitsOfMeasureInput

Type: object

Title: ApiEntityUnitsOfMeasureInput

This entity represents a UnitsOfMeasure object, a unique UnitsOfMeasure object can be identified by the following combinations of the fields.

• unitOfMeasureId
• key,workspaceId
• key,workspaceCode

Note: unitOfMeasureId cannot be used as a combination in Create operations.

Show Source

• displayName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of the unit of measure.
• key(required): string
  Minimum Length: 0

  Maximum Length: 60

  The abbreviation for the unit of measure name.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the unit of measure.
• unitOfMeasureId: integer (int64)
  The unique identifier for the unit of measure.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The code of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityUnitsOfMeasureInput",
    "required":[
        "displayName",
        "key",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "key":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "types":[
                "string"
            ]
        },
        "displayName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the unit of measure.",
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The code of a workspace.",
            "types":[
                "string"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the unit of measure.",
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "types":[
                "integer"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the unit of measure.",
            "format":"int64",
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a UnitsOfMeasure object, a unique UnitsOfMeasure object can be identified by the following combinations of the fields.<ul><li>unitOfMeasureId</li><li>key,workspaceId</li><li>key,workspaceCode</li></ul><b>Note:</b> <i>unitOfMeasureId</i> cannot be used as a combination in Create operations."
}

Examples

Select an example Update a Units of Measure Using Unit Of Measure ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Units of Measure service.

Back to Top