Jump to

• Request
• Response

Read ProjectFunding

get

/projectFunding

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

Type: array

Title: List<ProjectFunding>

Show Source

• Array of: object ProjectFunding
  Title: ProjectFunding

  ProjectFunding Entity

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

Nested Schema : ProjectFunding

Type: object

Title: ProjectFunding

ProjectFunding Entity

Show Source

• Amount: number (double)
  The amount of a funding source that is allocated to the project.
• CreateDate: string (date-time)
  The date this project funding data was created.
• CreateUser: string
  The name of the user that created this project funding data.
• FundingSourceName: string
• FundingSourceObjectId(required): integer (int32)
  The unique ID of the associated funding source for this project funding.
• FundShare: number (double)
  The percentage of the total fund that is allocated to the 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.
• LastUpdateDate: string (date-time)
  The date this project funding data was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project funding data.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ProjectId: string
  The short code that uniquely identifies the associated project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project source for this project funding.

{
    "title":"ProjectFunding",
    "required":[
        "FundingSourceObjectId",
        "ProjectObjectId"
    ],
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"The amount of a funding source that is allocated to the project.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this project funding data was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project funding data."
        },
        "FundShare":{
            "type":"number",
            "description":"The percentage of the total fund that is allocated to the project.",
            "format":"double"
        },
        "FundingSourceName":{
            "type":"string"
        },
        "FundingSourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated funding source for this project funding.",
            "format":"int32"
        },
        "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 project funding data was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project funding data."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project source for this project funding.",
            "format":"int32"
        }
    },
    "description":"ProjectFunding 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