Jump to

• Request
• Response

Batch Update Curves

put

/api/restapi/curve/batch

Send a request to this endpoint to update one or more curves. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityCurveInput>

Type: array

Title: List<ApiEntityCurveInput>

Show Source

• Array of: object ApiEntityCurveInput
  Title: ApiEntityCurveInput

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

  • curveId
  • curveName,workspaceId
  • curveName,workspaceCode

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

Nested Schema : ApiEntityCurveInput

Type: object

Title: ApiEntityCurveInput

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

• curveId
• curveName,workspaceId
• curveName,workspaceCode

Show Source

• buckets: array buckets
  The buckets of a cost curve.
• curveId: integer (int64)
  The unique identifier of a curve.
• curveName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the curve profile.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  It describes how data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier 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":"ApiEntityCurveInput",
    "required":[
        "curveName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "buckets":{
            "type":"array",
            "description":"The buckets of a cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCurveBucketInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "curveName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"It describes how data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "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",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "description":"This entity represents a Curve object, a unique Curve object can be identified by the following combinations of the fields.<ul><li>curveId</li><li>curveName,workspaceId</li><li>curveName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : buckets

Type: array

The buckets of a cost curve.

Show Source

• Array of: object ApiEntityCurveBucketInput
  Title: ApiEntityCurveBucketInput

{
    "type":"array",
    "description":"The buckets of a cost curve.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCurveBucketInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCurveBucketInput

Type: object

Title: ApiEntityCurveBucketInput

Show Source

• bucketLevel(required): integer (int32)
  The level of a curve bucket.
• curveBucketId: integer (int64)
  The unique identifier of a curve bucket.
• curveId: integer (int64)
  The unique identifier of a curve.
• value: number
  Numeric value of a bucket curve. Curve bucket values determine the shape of curves.

{
    "title":"ApiEntityCurveBucketInput",
    "required":[
        "bucketLevel"
    ],
    "type":"object",
    "properties":{
        "value":{
            "type":"number",
            "description":"Numeric value of a bucket curve. Curve bucket values determine the shape of curves.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "bucketLevel":{
            "type":"integer",
            "description":"The level of a curve bucket.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveBucketId":{
            "type":"integer",
            "description":"The unique identifier of a curve bucket.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Curves Using Curve ID

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 Curve service. Verify the request contains valid data, then resubmit the request.

Back to Top