View a Curve
get
/primeapi/restapi/curve/{id}
This endpoint returns a curve. that meet the following requirements:
- The object has an ID that matches the value of the {id} path parameter.
Request
Path Parameters
-
id: integer(int64)
ID of the curve that has to be found.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityCurve
Type:
Show Source
object
-
buckets(optional):
array buckets
Unique Items Required:
true
The buckets of a cost curve. -
curveId:
integer(int64)
The unique identifier of a curve.
-
curveName:
string
The name of the curve profile.
-
link(optional):
string(url)
Read Only:
true
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
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(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceId:
integer(int64)
The unique identifier of a workspace.
Nested Schema : buckets
Type:
array
Unique Items Required:
true
The buckets of a cost curve.
Show Source
Nested Schema : ApiEntityCurveBucket
Type:
Show Source
object
-
bucketLevel(optional):
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(optional):
string(url)
Read Only:
true
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
value(optional):
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.