Jump to

• Request
• Response

Reads ProjectIssue

get

/projectIssue

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

Type: array

Title: List<ProjectIssue>

Show Source

• Array of: object ProjectIssue
  Title: ProjectIssue

  ProjectIssue Entity

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

Nested Schema : ProjectIssue

Type: object

Title: ProjectIssue

ProjectIssue Entity

Show Source

• ActivityId: string
  The short ID that uniquely identifies the activity within the project.
• ActivityName: string
  The name of the activity. The activity name does not have to be unique.
• ActivityObjectId(required): integer (int32)
  The unique ID of the activity to which the project issue applies.
• ActualValue: number (double)
  The actual value of the threshold parameter for the project issue. Issues are automatically generated by the threshold monitor when actual values of threshold parameters exceed target values.
• CreateDate: string (date-time)
  The date this project issue was created.
• CreateUser: string
  The name of the user that created this project issue.
• DateIdentified: string (date-time)
  The date the project issue was identified.
• IdentifiedBy: string
  The identifier of the project issue. This may be the name of the user who created the project issue or Monitor, if the project issue was automatically generated by the threshold monitor.
• 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 issue was last updated.
• LastUpdateUser: string
  The name of the user that last updated this project issue.
• LowerThreshold: number (double)
  The lower value of the threshold parameter that triggered the project issue. Issues are triggered when the actual/observed parameters values are less than or equal to the lower threshold.
• Name(required): string
  The name of the project issue. Issues which are automatically generated by the threshold monitor are named after the threshold parameter that triggered the project issue.
• Notes: string
  The notes associated with the project issue.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• OBSName: string
  The name of the person/role in the organization, sometimes referred to as the "responsible manager".
• OBSObjectId: integer (int32)
  The unique ID of the project manager from the project's OBS tree who is responsible for the project issue.
• Priority: string
  The priority of the project issue. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'.
• ProjectId: string
  The short code that uniquely identifies the project.
• ProjectName: string
  The name of the associated project.
• ProjectObjectId(required): integer (int32)
  The unique ID of the associated project.
• ProjectThresholdObjectId: integer (int32)
  The unique ID of the associated project threshold for the project issue.
• RawTextNote: string
  The notes associated with the project issue.
• ResolutionDate: string (date-time)
  The date the project issue was resolved.
• ResourceId: string
  The short code that uniquely identifies the resource.
• ResourceName: string
  The name of the resource.
• ResourceObjectId: integer (int32)
  The unique ID of the associated resource for this project issue. If a parent resource is selected, the issue applies to all child resources as well.
• Status: string
  The current status of the project issue. Valid values are 'Open', 'On Hold', and 'Closed'.
• ThresholdParameterObjectId: integer (int32)
  The unique ID of the associated threshold parameter for the project issue.
• UpperThreshold: number (double)
  The upper value of the threshold parameter which triggered the project issue. Issues are triggered when the actual/observed parameters values are greater than or equal to the upper threshold.
• WBSCode: string
  The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.
• WBSName: string
  The name of the WBS element.
• WBSObjectId(required): integer (int32)
  The unique ID of the WBS to which the project issue applies. If a parent WBS is selected, the project issue applies to all child elements as well. If the top WBS is selected, the project issue applies to the entire project.

{
    "title":"ProjectIssue",
    "required":[
        "ActivityObjectId",
        "Name",
        "ProjectObjectId",
        "WBSObjectId"
    ],
    "type":"object",
    "properties":{
        "ActivityId":{
            "type":"string",
            "description":"The short ID that uniquely identifies the activity within the project."
        },
        "ActivityName":{
            "type":"string",
            "description":"The name of the activity. The activity name does not have to be unique."
        },
        "ActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the activity to which the project issue applies.",
            "format":"int32"
        },
        "ActualValue":{
            "type":"number",
            "description":"The actual value of the threshold parameter for the project issue. Issues are automatically generated by the threshold monitor when actual values of threshold parameters exceed target values.",
            "format":"double"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this project issue was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this project issue."
        },
        "DateIdentified":{
            "type":"string",
            "description":"The date the project issue was identified.",
            "format":"date-time"
        },
        "IdentifiedBy":{
            "type":"string",
            "description":"The identifier of the project issue. This may be the name of the user who created the project issue or Monitor, if the project issue was automatically generated by the threshold monitor."
        },
        "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 issue was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this project issue."
        },
        "LowerThreshold":{
            "type":"number",
            "description":"The lower value of the threshold parameter that triggered the project issue. Issues are triggered when the actual/observed parameters values are less than or equal to the lower threshold.",
            "format":"double"
        },
        "Name":{
            "type":"string",
            "description":"The name of the project issue. Issues which are automatically generated by the threshold monitor are named after the threshold parameter that triggered the project issue."
        },
        "Notes":{
            "type":"string",
            "description":"The notes associated with the project issue."
        },
        "OBSName":{
            "type":"string",
            "description":"The name of the person/role in the organization, sometimes referred to as the \"responsible manager\"."
        },
        "OBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the project manager from the project's OBS tree who is responsible for the project issue.",
            "format":"int32"
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "Priority":{
            "type":"string",
            "description":"The priority of the project issue. Valid values are 'Top', 'High', 'Normal', 'Low', and 'Lowest'."
        },
        "ProjectId":{
            "type":"string",
            "description":"The short code that uniquely identifies the project."
        },
        "ProjectName":{
            "type":"string",
            "description":"The name of the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "ProjectThresholdObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project threshold for the project issue.",
            "format":"int32"
        },
        "RawTextNote":{
            "type":"string",
            "description":"The notes associated with the project issue."
        },
        "ResolutionDate":{
            "type":"string",
            "description":"The date the project issue was resolved.",
            "format":"date-time"
        },
        "ResourceId":{
            "type":"string",
            "description":"The short code that uniquely identifies the resource."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource for this project issue. If a parent resource is selected, the issue applies to all child resources as well.",
            "format":"int32"
        },
        "Status":{
            "type":"string",
            "description":"The current status of the project issue. Valid values are 'Open', 'On Hold', and 'Closed'."
        },
        "ThresholdParameterObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated threshold parameter for the project issue.",
            "format":"int32"
        },
        "UpperThreshold":{
            "type":"number",
            "description":"The upper value of the threshold parameter which triggered the project issue. Issues are triggered when the actual/observed parameters values are greater than or equal to the upper threshold.",
            "format":"double"
        },
        "WBSCode":{
            "type":"string",
            "description":"The short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes."
        },
        "WBSName":{
            "type":"string",
            "description":"The name of the WBS element."
        },
        "WBSObjectId":{
            "type":"integer",
            "description":"The unique ID of the WBS to which the project issue applies. If a parent WBS is selected, the project issue applies to all child elements as well. If the top WBS is selected, the project issue applies to the entire project.",
            "format":"int32"
        }
    },
    "description":"ProjectIssue 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