Jump to

• Request
• Response

Read Document

get

/document

Reads Document 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<Document>

Type: array

Title: List<Document>

Show Source

• Array of: object Document
  Title: Document

  Document Entity

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

Nested Schema : Document

Type: object

Title: Document

Document Entity

Show Source

• ActivityObjectId: integer (int32)
• Author: string
  The person who created the work product or document.
• ContentRepositoryDocumentInternalId: string
  The internal ID of the content repository document.
• CreateDate: string (date-time)
  The date this document was created.
• CreateUser: string
  The name of the user that created this document.
• Deliverable: boolean
  The flag that indicates that the work product or document is a project deliverable.
• Description: string
  The narrative description of the work product or document.
• DocumentCategoryName: string
  The name of the associated document category.
• DocumentCategoryObjectId: integer (int32)
  The unique ID of the associated document category.
• DocumentStatusCodeName: string
  The name of the associated document status code.
• DocumentStatusCodeObjectId: integer (int32)
  The unique ID of the associated document status code.
• DocumentType: string
  The type of document: 'Non-Collaboration' or 'Collaboration'.
• GUID: string
  The globally unique ID generated by the system.
• 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.
• 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.
• ParentObjectId: integer (int32)
  The unique ID of the parent document of this document in the hierarchy.
• PrivateLocation: string
  The work product or document's private file location.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• PublicLocation: string
  The work product or document's publicly-accessible file location.
• ReferenceNumber: string
  The work product or document's reference or catalog number.
• ResourceId: string
  The short code that uniquely identifies the associated resource.
• ResourceName: string
  The name of the associated resource.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource.
• RevisionDate: string (date-time)
  The date of the work product or document's last update.
• SequenceNumber: integer (int32)
  The sequence number for sorting.
• Title(required): string
  The title or name of a project work product or document.
• Version: string
  The work product or document's version number.

{
    "title":"Document",
    "required":[
        "ProjectObjectId",
        "Title"
    ],
    "type":"object",
    "properties":{
        "ActivityObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "Author":{
            "type":"string",
            "description":"The person who created the work product or document."
        },
        "ContentRepositoryDocumentInternalId":{
            "type":"string",
            "description":"The internal ID of the content repository document."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this document was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this document."
        },
        "Deliverable":{
            "type":"boolean",
            "description":"The flag that indicates that the work product or document is a project deliverable."
        },
        "Description":{
            "type":"string",
            "description":"The narrative description of the work product or document."
        },
        "DocumentCategoryName":{
            "type":"string",
            "description":"The name of the associated document category."
        },
        "DocumentCategoryObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated document category.",
            "format":"int32"
        },
        "DocumentStatusCodeName":{
            "type":"string",
            "description":"The name of the associated document status code."
        },
        "DocumentStatusCodeObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated document status code.",
            "format":"int32"
        },
        "DocumentType":{
            "type":"string",
            "description":"The type of document: 'Non-Collaboration' or 'Collaboration'."
        },
        "GUID":{
            "type":"string",
            "description":"The globally unique ID generated by the system."
        },
        "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."
        },
        "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"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent document of this document in the hierarchy.",
            "format":"int32"
        },
        "PrivateLocation":{
            "type":"string",
            "description":"The work product or document's private file location."
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "PublicLocation":{
            "type":"string",
            "description":"The work product or document's publicly-accessible file location."
        },
        "ReferenceNumber":{
            "type":"string",
            "description":"The work product or document's reference or catalog number."
        },
        "ResourceId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated resource."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the associated resource."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource.",
            "format":"int32"
        },
        "RevisionDate":{
            "type":"string",
            "description":"The date of the work product or document's last update.",
            "format":"date-time"
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        },
        "Title":{
            "type":"string",
            "description":"The title or name of a project work product or document."
        },
        "Version":{
            "type":"string",
            "description":"The work product or document's version number."
        }
    },
    "description":"Document 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