Jump to

• Request
• Response

Read ProjectDocument

get

/projectDocument

Reads ProjectDocument objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<ProjectDocument>

Type: array

Title: List<ProjectDocument>

Show Source

• Array of: object ProjectDocument
  Title: ProjectDocument

  ProjectDocument Entity

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

Nested Schema : ProjectDocument

Type: object

Title: ProjectDocument

ProjectDocument Entity

Show Source

• ActivityId: string
  The short ID that uniquely identifies the activity within the project.
• ActivityName: string
  The name of the activity. The activity name does not have to be unique.
• ActivityObjectId(required): integer (int32)
  The unique ID of the activity to which the activity document applies.
• CreateDate: string (date-time)
  The date this document was created.
• CreateUser: string
  The date this document was created.
• DocumentCategoryName: string
• DocumentObjectId(required): integer (int32)
  The unique ID of the document to which the activity document applies.
• DocumentStatusName: string
• DocumentTitle: string
  The title or name of a document assigned to a WBS or activity within a project.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• IsWorkProduct: boolean
  The flag that indicates whether the document is a work product.
• LastUpdateDate: string (date-time)
  The date this document was last updated.
• LastUpdateUser: string
  The name of the user that last updated this document.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentWBSObjectId: integer (int32)
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the project to which the activity document applies.
• 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 to which the activity document applies.

{
    "title":"ProjectDocument",
    "required":[
        "ActivityObjectId",
        "DocumentObjectId",
        "ProjectObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityId":{
            "type":"string",
            "description":"The short ID that uniquely identifies the activity within the project."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of the activity. The activity name does not have to be unique."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which the activity document applies.",
            "format":"int32"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this document was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The date this document was created."
        },
        "DocumentCategoryName":{
            "type":"string"
        },
        "DocumentObjectId":{
            "type":"integer",
            "description":"The unique ID of the document to which the activity document applies.",
            "format":"int32"
        },
        "DocumentStatusName":{
            "type":"string"
        },
        "DocumentTitle":{
            "type":"string",
            "description":"The title or name of a document assigned to a WBS or activity within a project."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline"
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "IsWorkProduct":{
            "type":"boolean",
            "description":"The flag that indicates whether the document is a work product."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this document was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this document."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentWBSObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the project to which the activity document applies.",
            "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 to which the activity document applies.",
            "format":"int32"
        }
    },
    "description":"ProjectDocument Entity"
}

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