Create a Rule of Credit
post
/api/restapi/ruleOfCredit
Send a request to this endpoint to create a rule of credit. 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 : ApiEntityRuleOfCreditInput
Type:
object
Title:
ApiEntityRuleOfCreditInput
This entity represents a RuleOfCredit object, a unique RuleOfCredit object can be identified by the following combinations of the fields.
Show Source
- rocId
- rocName,workspaceId
- rocName,workspaceCode
-
associationType: stringAllowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 23.12.The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
milestones(required): array
milestones
The milestones associated with the rule of credit.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the rule of credit. -
rocId: integer
(int64)
Unique identifier of the rule of credit.
-
rocName(required): string
Minimum Length:
1
Maximum Length:255
The name of the rule of credit. -
type: string
Allowed Values:
[ "MANUAL", "ZERO_TO_ONE_HUNDRED" ]
Determines how each milestone in a rule of credit can be progressed.
Manual: Allows partial completion of a milestone, entered as a percentage.
0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.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 : milestones
Type:
array
The milestones associated with the rule of credit.
Show Source
-
Array of:
object ApiEntityRuleOfCreditMilestoneInput
Title:
ApiEntityRuleOfCreditMilestoneInput
Nested Schema : ApiEntityRuleOfCreditMilestoneInput
Type:
object
Title:
Show Source
ApiEntityRuleOfCreditMilestoneInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
link: string(url)Read Only:true
Deprecated. As of 23.12.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
milestoneId: integer
(int64)
Unique identifier of the rule of credit milestone.
-
milestoneName(required): string
Minimum Length:
1
Maximum Length:255
The name of the milestone for the rule of credit. -
percentComplete(required): number
(double)
Minimum Value:
0
Maximum Value:1
The percentage of work to be completed for the milestone in relation to the entire rule of credit. -
ruleOfCreditId: integer
(int64)
The unique identifier of a rule of credit.
-
sequenceNumber(required): integer
(int32)
The number that specifies the position of a milestone in a milestone list.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.12.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityRuleOfCredit
Type:
object
Title:
Show Source
ApiEntityRuleOfCredit
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
milestones: array
milestones
The milestones associated with the rule of credit.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the rule of credit. -
rocId: integer
(int64)
Unique identifier of the rule of credit.
-
rocName: string
Minimum Length:
1
Maximum Length:255
The name of the rule of credit. -
type: string
Allowed Values:
[ "MANUAL", "ZERO_TO_ONE_HUNDRED" ]
Determines how each milestone in a rule of credit can be progressed.
Manual: Allows partial completion of a milestone, entered as a percentage.
0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete. -
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 : milestones
Type:
array
The milestones associated with the rule of credit.
Show Source
-
Array of:
object ApiEntityRuleOfCreditMilestone
Title:
ApiEntityRuleOfCreditMilestone
Nested Schema : ApiEntityRuleOfCreditMilestone
Type:
object
Title:
Show Source
ApiEntityRuleOfCreditMilestone
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
milestoneId: integer
(int64)
Unique identifier of the rule of credit milestone.
-
milestoneName(required): string
Minimum Length:
1
Maximum Length:255
The name of the milestone for the rule of credit. -
percentComplete(required): number
(double)
Minimum Value:
0
Maximum Value:1
The percentage of work to be completed for the milestone in relation to the entire rule of credit. -
ruleOfCreditId: integer
(int64)
The unique identifier of a rule of credit.
-
sequenceNumber(required): integer
(int32)
The number that specifies the position of a milestone in a milestone list.
-
updateDate: string
(date-time)
Date when the record was last updated.
400 Response
Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request.