Jump to

• Request
• Response

Batch Create Rules of Credit

post

/api/restapi/ruleOfCredit/batch

Send a request to this endpoint to create one or more rules of credit. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityRuleOfCreditInput>

Type: array

Title: List<ApiEntityRuleOfCreditInput>

Show Source

• Array of: object ApiEntityRuleOfCreditInput
  Title: ApiEntityRuleOfCreditInput

  This entity represents a RuleOfCredit object, a unique RuleOfCredit object can be identified by the following combinations of the fields.

  • rocId
  • rocName,workspaceId
  • rocName,workspaceCode

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

Nested 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.

• rocId
• rocName,workspaceId
• rocName,workspaceCode

Show Source

• associationType: string
  Allowed 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.

{
    "title":"ApiEntityRuleOfCreditInput",
    "required":[
        "milestones",
        "rocName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"Determines how each milestone in a rule of credit can be progressed. <br />Manual: Allows partial completion of a milestone, entered as a percentage. <br />0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "ZERO_TO_ONE_HUNDRED"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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":"The push down type of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited.",
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "milestones":{
            "type":"array",
            "description":"The milestones associated with the rule of credit.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a RuleOfCredit object, a unique RuleOfCredit object can be identified by the following combinations of the fields.<ul><li>rocId</li><li>rocName,workspaceId</li><li>rocName,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : milestones

Type: array

The milestones associated with the rule of credit.

Show Source

• Array of: object ApiEntityRuleOfCreditMilestoneInput
  Title: ApiEntityRuleOfCreditMilestoneInput

{
    "type":"array",
    "description":"The milestones associated with the rule of credit.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestoneInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRuleOfCreditMilestoneInput

Type: object

Title: ApiEntityRuleOfCreditMilestoneInput

Show Source

• 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.

{
    "title":"ApiEntityRuleOfCreditMilestoneInput",
    "required":[
        "milestoneName",
        "percentComplete",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of a milestone in a milestone list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ruleOfCreditId":{
            "type":"integer",
            "description":"The unique identifier of a rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "percentComplete":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The percentage of work to be completed for the milestone in relation to the entire rule of credit.",
            "format":"double",
            "exampleSetFlag":false
        },
        "milestoneName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the milestone for the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "milestoneId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create Rules of Credit

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityRuleOfCredit>

Type: array

Title: List<ApiEntityRuleOfCredit>

Show Source

• Array of: object ApiEntityRuleOfCredit
  Title: ApiEntityRuleOfCredit

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

Nested Schema : ApiEntityRuleOfCredit

Type: object

Title: ApiEntityRuleOfCredit

Show Source

• 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.

{
    "title":"ApiEntityRuleOfCredit",
    "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"
            ]
        },
        "type":{
            "type":"string",
            "description":"Determines how each milestone in a rule of credit can be progressed. <br />Manual: Allows partial completion of a milestone, entered as a percentage. <br />0/100%: Partial progress cannot be made when progressing a milestone. As soon as the milestone is selected, the milestone is 100% complete.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "ZERO_TO_ONE_HUNDRED"
            ]
        },
        "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"
            ]
        },
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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":"The push down type of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the rule of credit and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "milestones":{
            "type":"array",
            "description":"The milestones associated with the rule of credit.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : milestones

Type: array

The milestones associated with the rule of credit.

Show Source

• Array of: object ApiEntityRuleOfCreditMilestone
  Title: ApiEntityRuleOfCreditMilestone

{
    "type":"array",
    "description":"The milestones associated with the rule of credit.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityRuleOfCreditMilestone",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityRuleOfCreditMilestone

Type: object

Title: ApiEntityRuleOfCreditMilestone

Show Source

• 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.

{
    "title":"ApiEntityRuleOfCreditMilestone",
    "required":[
        "milestoneName",
        "percentComplete",
        "sequenceNumber"
    ],
    "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"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of a milestone in a milestone list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "ruleOfCreditId":{
            "type":"integer",
            "description":"The unique identifier of a rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "percentComplete":{
            "maximum":"1",
            "minimum":"0",
            "type":"number",
            "description":"The percentage of work to be completed for the milestone in relation to the entire rule of credit.",
            "format":"double",
            "exampleSetFlag":false
        },
        "milestoneName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the milestone for the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "milestoneId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit milestone.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the rule of credit service. Verify the request contains valid data, then resubmit the request.

Back to Top