View a Curve by Workspace and Name
get
/api/restapi/curve/workspace/{workspaceId}/name/{curveName}
This endpoint returns curves that meet the following requirements:
- The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
- The object has a code that matches the value of the {curveName} path parameter.
Request
Path Parameters
-
curveName(required): string
curveName of curve to be found.
-
workspaceId(required): integer(int64)
ID of workspace and name of the curve that has to be found.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityCurve
Type:
object
Title:
Show Source
ApiEntityCurve
-
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.
Nested Schema : buckets
Type:
array
The buckets of a cost curve.
Show Source
-
Array of:
object ApiEntityCurveBucket
Title:
ApiEntityCurveBucket
Nested Schema : ApiEntityCurveBucket
Type:
object
Title:
Show Source
ApiEntityCurveBucket
-
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.
404 Response
The requested curve does not exist, or you do not have access to it.