Jump to

• Request
• Response

Update WBSMilestone

put

/wbsMilestone

Send a request to this endpoint to update one or more WBSMilestone. An application object will be created for each JSON object provided in the request body

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of WBSMilestone objects.

Root Schema : List<WBSMilestone>

Type: array

Title: List<WBSMilestone>

Show Source

• Array of: object WBSMilestone
  Title: WBSMilestone

  WBSMilestone Entity

{
    "title":"List<WBSMilestone>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/WBSMilestone"
    }
}

Nested Schema : WBSMilestone

Type: object

Title: WBSMilestone

WBSMilestone Entity

Show Source

• CreateDate: string (date-time)
  The date this WBS milestone was created.
• CreateUser: string
  The name of the user that created this WBS milestone.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsCompleted: boolean
  The flag that indicates whether the step has been completed.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this WBS milestone was last updated.
• LastUpdateUser: string
  The name of the user that last updated this WBS milestone.
• Name(required): string
  The name of the WBS milestone.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• SequenceNumber: integer (int32)
  The sequence number for sorting.
• WBSCode: string
  The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.
• WBSName: string
  The name of the WBS element.
• WBSObjectId(required): integer (int32)
  The unique ID of the WBS where the WBS milestone is assigned.
• Weight: number (double)
  The weight that is assigned to the milestone.

{
    "title":"WBSMilestone",
    "required":[
        "Name",
        "ProjectObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this WBS milestone was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this WBS milestone."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsCompleted":{
            "type":"boolean",
            "description":"The flag that indicates whether the step has been completed."
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this WBS milestone was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this WBS milestone."
        },
        "Name":{
            "type":"string",
            "description":"The name of the WBS milestone."
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        },
        "WBSCode":{
            "type":"string",
            "description":"The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes."
        },
        "WBSName":{
            "type":"string",
            "description":"The name of the WBS element."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS where the WBS milestone is assigned.",
            "format":"int32"
        },
        "Weight":{
            "type":"number",
            "description":"The weight that is assigned to the milestone.",
            "format":"double"
        }
    },
    "description":"WBSMilestone Entity"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : schema

Type: boolean

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top