Create a Curve
post
/api/restapi/curve
Send a request to this endpoint to create a curve. An application object will be created using the JSON data provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root 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.
Show Source
- curveId
- curveName,workspaceId
- curveName,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 24.5.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(required): string
Minimum Length:
1
Maximum Length:255
The name of the curve profile. -
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" ]
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)Read Only:true
Deprecated. As of 24.5.Date when the record was last updated. -
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.
Nested Schema : buckets
Type:
array
The buckets of a cost curve.
Show Source
-
Array of:
object ApiEntityCurveBucketInput
Title:
ApiEntityCurveBucketInput
Nested Schema : ApiEntityCurveBucketInput
Type:
object
Title:
Show Source
ApiEntityCurveBucketInput
-
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.
-
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. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 24.5.Date when the record was last updated. -
value: number
Numeric value of a bucket curve. Curve bucket values determine the shape of curves.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
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.
400 Response
Invalid input for the Curve service. Verify the request contains valid data, then resubmit the request.