Jump to

• Request
• Response

Read ProjectDeployment

get

/projectDeployment

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

Type: array

Title: List<ProjectDeployment>

Show Source

• Array of: object ProjectDeployment
  Title: ProjectDeployment

  ProjectDeployment Entity

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

Nested Schema : ProjectDeployment

Type: object

Title: ProjectDeployment

ProjectDeployment Entity

Show Source

• DeploymentName: string
• DeploymentObjectId: integer (int32)
• ObjectId: integer (int32)
• ProjectObjectId: integer (int32)
• ProviderName: string

{
    "title":"ProjectDeployment",
    "type":"object",
    "properties":{
        "DeploymentName":{
            "type":"string"
        },
        "DeploymentObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "format":"int32"
        },
        "ProviderName":{
            "type":"string"
        }
    },
    "description":"ProjectDeployment 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