Jump to

• Request
• Response

Read ProjectCodeAssignment

get

/projectCodeAssignment

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

Type: array

Title: List<ProjectCodeAssignment>

Show Source

• Array of: object ProjectCodeAssignment
  Title: ProjectCodeAssignment

  ProjectCodeAssignment Entity

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

Nested Schema : ProjectCodeAssignment

Type: object

Title: ProjectCodeAssignment

ProjectCodeAssignment Entity

Show Source

• CreateDate: string (date-time)
  The date this code assignment was created.
• CreateUser: string
  The name of the user that created this code assignment.
• 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 code assignment was last updated.
• LastUpdateUser: string
  The name of the user that last updated this code assignment.
• ProjectCodeDescription: string
  The description of the associated project code.
• ProjectCodeObjectId(required): integer (int32)
  The unique ID of the associated project code.
• ProjectCodeTypeName: string
  The name of the parent project code type.
• ProjectCodeTypeObjectId: integer (int32)
  The unique ID of the parent project code type.
• ProjectCodeValue: string
  The value of the associated project code.
• ProjectId: string
  The short code that uniquely identifies the associated project.
• ProjectName: string
  The name of the project to which the project code is assigned.
• ProjectObjectId(required): integer (int32)
  The unique ID of the project to which the project code is assigned.
• WBSObjectId: integer (int32)

{
    "title":"ProjectCodeAssignment",
    "required":[
        "ProjectCodeObjectId",
        "ProjectObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this code assignment was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this code assignment."
        },
        "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 code assignment was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this code assignment."
        },
        "ProjectCodeDescription":{
            "type":"string",
            "description":"The description of the associated project code."
        },
        "ProjectCodeObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project code.",
            "format":"int32"
        },
        "ProjectCodeTypeName":{
            "type":"string",
            "description":"The name of the parent project code type."
        },
        "ProjectCodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent project code type.",
            "format":"int32"
        },
        "ProjectCodeValue":{
            "type":"string",
            "description":"The value of the associated project code."
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated project."
        },
        "ProjectName":{
            "type":"string",
            "description":"The name of the project to which the project code is assigned."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the project to which the project code is assigned.",
            "format":"int32"
        },
        "WBSObjectId":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"ProjectCodeAssignment 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