Jump to

• Request
• Response

View Rule of Credit Milestones

get

/api/restapi/ruleOfCredit/ROCMilestone/{rocId}

This endpoint returns rule of credit milestones that meet the following requirements:

• The object is associated with a rule of credit with an ID value that matches the value of the {rocId} path parameter.

Request

Path Parameters

• rocId(required): integer(int64)
  The system-generated identifier of a rule of credit.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityRuleOfCreditMilestone>

Type: array

Title: List<ApiEntityRuleOfCreditMilestone>

Show Source

• Array of: object ApiEntityRuleOfCreditMilestone
  Title: ApiEntityRuleOfCreditMilestone

{
    "title":"List<ApiEntityRuleOfCreditMilestone>",
    "type":"array",
    "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
}

204 Response

Successful operation with no content.

404 Response

The requested rule of credit milestone does not exist, or you do not have access to it.

Back to Top