Jump to

• Request
• Response

Batch Update Units of Measures

put

/api/restapi/unitsOfMeasure/batch

Send a request to this endpoint to update one or more units of measure.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityUnitsOfMeasureInput>

Type: array

Title: List<ApiEntityUnitsOfMeasureInput>

Show Source

• Array of: object ApiEntityUnitsOfMeasureInput
  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

{
    "title":"List<ApiEntityUnitsOfMeasureInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUnitsOfMeasureInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested 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

Show Source

• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 24.5.
  The type of association in the relationship between the units of measure and the workspace. Possible values are Owned and Inherited.
• 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.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.5.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 24.5.
  Date when the record was last updated.
• 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":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "displayName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the unit of measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "key":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The code of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the unit of measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the unit of measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.5</i>.</br>The type of association in the relationship between the units of measure and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        }
    },
    "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>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Units of Measures Using Unit Of Measure IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

Invalid input for the Units of Measure service.

Back to Top