Jump to

• Request
• Response

View a Curve by Name

get

/api/restapi/curve/name/{curveName}

This endpoint returns a curve that meet the following requirements:

• The object has a code that matches the value of the {curveName} path parameter.

Request

Path Parameters

• curveName(required): string
  Name of the curve that has to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCurve>

Type: array

Title: List<ApiEntityCurve>

Show Source

• Array of: object ApiEntityCurve
  Title: ApiEntityCurve

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

Nested Schema : ApiEntityCurve

Type: object

Title: ApiEntityCurve

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited.
• buckets: array buckets
  The buckets of a cost curve.
• curveId: integer (int64)
  The unique identifier of a curve.
• curveName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the curve profile.
• link: string (url)
  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" ]

  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.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityCurve",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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":"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"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the curve and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "buckets":{
            "type":"array",
            "description":"The buckets of a cost curve.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCurveBucket",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : buckets

Type: array

The buckets of a cost curve.

Show Source

• Array of: object ApiEntityCurveBucket
  Title: ApiEntityCurveBucket

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

Nested Schema : ApiEntityCurveBucket

Type: object

Title: ApiEntityCurveBucket

Show Source

• bucketLevel: 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.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.
• value: number
  Numeric value of a bucket curve. Curve bucket values determine the shape of curves.

{
    "title":"ApiEntityCurveBucket",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "value":{
            "type":"number",
            "description":"Numeric value of a bucket curve. Curve bucket values determine the shape of curves.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveBucketId":{
            "type":"integer",
            "description":"The unique identifier of a curve bucket.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "bucketLevel":{
            "type":"integer",
            "description":"The level of a curve bucket.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested curve does not exist, or you do not have access to it.

Back to Top