Jump to

• Request
• Response

Read ProjectPortfolio

get

/projectPortfolio

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

Type: array

Title: List<ProjectPortfolio>

Show Source

• Array of: object ProjectPortfolio
  Title: ProjectPortfolio

  ProjectPortfolio Entity

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

Nested Schema : ProjectPortfolio

Type: object

Title: ProjectPortfolio

ProjectPortfolio Entity

Show Source

• CreateDate: string (date-time)
  The date this project portfolio was created.
• CreateUser: string
  The name of the user that created this project portfolio.
• Description: string
  The description of the project portfolio.
• IncludeClosedProjects: boolean
  The flag that indicates whether closed projects are included in the portfolio.
• IncludeWhatIfProjects: boolean
  The flag that indicates whether what-if projects are included in the portfolio.
• LastUpdateDate: string (date-time)
  The date this project portfolio was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project portfolio.
• MemberProject: array MemberProject
  MemberProject
• Name(required): string
  The name of the project portfolio.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PortfolioUserIdArray: string
• PortfolioUserNameArray: string
• Type: string
  The type of the project portfolio: "Manual", "Auto-Maintained", or "Filtered".
• UserName: string
  The user's login name.
• UserObjectId: integer (int32)
  The unique ID of a specific user who has access to the selected project portfolio.

{
    "title":"ProjectPortfolio",
    "required":[
        "Name"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this project portfolio was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project portfolio."
        },
        "Description":{
            "type":"string",
            "description":"The description of the project portfolio."
        },
        "IncludeClosedProjects":{
            "type":"boolean",
            "description":"The flag that indicates whether closed projects are included in the portfolio."
        },
        "IncludeWhatIfProjects":{
            "type":"boolean",
            "description":"The flag that indicates whether what-if projects are included in the portfolio."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this project portfolio was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project portfolio."
        },
        "Name":{
            "type":"string",
            "description":"The name of the project portfolio."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PortfolioUserIdArray":{
            "type":"string"
        },
        "PortfolioUserNameArray":{
            "type":"string"
        },
        "Type":{
            "type":"string",
            "description":"The type of the project portfolio: \"Manual\", \"Auto-Maintained\", or \"Filtered\"."
        },
        "UserName":{
            "type":"string",
            "description":"The user's login name."
        },
        "UserObjectId":{
            "type":"integer",
            "description":"The unique ID of a specific user who has access to the selected project portfolio.",
            "format":"int32"
        },
        "MemberProject":{
            "type":"array",
            "description":"MemberProject",
            "items":{
                "$ref":"#/components/schemas/MemberProject"
            }
        }
    },
    "description":"ProjectPortfolio Entity"
}

Nested Schema : MemberProject

Type: array

MemberProject

Show Source

• Array of: object MemberProject
  MemberProject

{
    "type":"array",
    "description":"MemberProject",
    "items":{
        "$ref":"#/components/schemas/MemberProject"
    }
}

Nested Schema : MemberProject

Type: object

MemberProject

Show Source

• Id: string
• Name: string
• ObjectId: integer (int32)

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        },
        "ObjectId":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"MemberProject"
}

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