Jump to

• Request
• Response

Read IssueHistory

get

/issueHistory

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

Type: array

Title: List<IssueHistory>

Show Source

• Array of: object IssueHistory
  Title: IssueHistory

  IssueHistory Entity

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

Nested Schema : IssueHistory

Type: object

Title: IssueHistory

IssueHistory Entity

Show Source

• CreateDate: string (date-time)
  The date this issue history was created.
• CreateUser: string
  The name of the user that created this issue history.
• 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 issue history was last updated.
• LastUpdateUser: string
  The name of the user that last updated this issue history.
• Notes: string
  The notes associated with the issue history.
• ProjectIssueObjectId: integer (int32)
  The unique ID of the associated project issue for this issue history.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project for this issue history.

{
    "title":"IssueHistory",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this issue history was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this issue history."
        },
        "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 issue history was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this issue history."
        },
        "Notes":{
            "type":"string",
            "description":"The notes associated with the issue history."
        },
        "ProjectIssueObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project issue for this issue history.",
            "format":"int32"
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project for this issue history.",
            "format":"int32"
        }
    },
    "description":"IssueHistory 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