Jump to

• Request
• Response

Batch Update Rules of Credit

put

/api/restapi/ruleOfCredit/batch

Send a request to this endpoint to update one or more rules of credit. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

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

• 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.
• 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":{
        "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"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "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.
• 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.

{
    "title":"ApiEntityRuleOfCreditMilestoneInput",
    "required":[
        "milestoneName",
        "percentComplete",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "milestoneId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit milestone.",
            "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
        },
        "ruleOfCreditId":{
            "type":"integer",
            "description":"The unique identifier of a rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of a milestone in a milestone list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "milestoneName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the milestone for the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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 Update Rules of Credits Using Rule of Credit IDs.

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

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

Back to Top