Added

Added SearchIssues endpoint.

This endpoint works the same as the GetIssues endpoint, with an extra attribute in the filter model Query, as well as an extra attribute AttributesToHighlight in the response Issue object.

New SearchIssues endpoint:

/v3/hubs/{hubId}/projects/{projectId}/issues/search

Attribute added to filter model:

filter.query: string(75)

Filter that searches in the issue Title, Number and Description.

Attribute added to Issue response model:

AttributesToHighlight: string[]

This attribute is included whenever the Query filter is sent with a value in the request, shows the list of attributes the Query value was found at (possible values are "Number", "Title" and "Description")

JSON response structure:

[
  {
    "Id": 0,
    "ProjectId": 0,
    "Title": "string",
    "Number": 0,
    "Description": "string",
    "Group": "string",
    "Author": {
      "Id": 0,
      "UserName": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "AvatarUrl": "string"
    },
    "AssignedTo": {
      "Id": 0,
      "UserName": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "AvatarUrl": "string"
    },
    "LastModificationAuthor": {
      "Id": 0,
      "UserName": "string",
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "AvatarUrl": "string"
    },
    "LastModificationDate": "2023-09-26T15:38:17.419Z",
    "DueDate": "2023-09-26T15:38:17.419Z",
    "CreationDate": "2023-09-26T15:38:17.419Z",
    "ClosingDate": "2023-09-26T15:38:17.419Z",
    "DefaultViewpointId": 0,
    "Disciplines": [
      {
        "Name": "string",
        "Id": 0
      }
    ],
    "ProjectPhase": {
      "Color": "string",
      "Name": "string",
      "Id": 0
    },
    "ProjectZone": {
      "Color": "string",
      "Name": "string",
      "Id": 0
    },
    "Priority": {
      "Order": 0,
      "Color": "string",
      "Name": "string",
      "Id": 0
    },
    "Status": {
      "TeamsAllowedForStatus": [
        {
          "Name": "string",
          "Id": 0
        }
      ],
      "Color": "string",
      "Name": "string",
      "Id": 0
    },
    "Type": {
      "Color": "string",
      "Name": "string",
      "Id": 0
    },
    "Confidentiality": {
      "Teams": [
        {
          "Team": {
            "Name": "string",
            "Id": 0
          }
        }
      ]
    },
    "NotifyList": {
      "TeamsToNotify": [
        {
          "Team": {
            "Name": "string",
            "Id": 0
          }
        }
      ],
      "UsersToNotify": [
        {
          "Id": 0,
          "UserName": "string",
          "Email": "string",
          "FirstName": "string",
          "LastName": "string",
          "AvatarUrl": "string"
        }
      ]
    },
    "CustomAttributes": [
      {
        "Id": 0,
        "Name": "string",
        "IsMandatory": true,
        "PredefinedValues": [
          {
            "Id": 0,
            "Color": "string",
            "Name": "string"
          }
        ],
        "TextValue": "string"
      }
    ],
    "CreationSource": "Unspecified",
    "Viewpoints": [
      {
        "Id": 0,
        "IssueId": 0,
        "ViewType": "None",
        "Image": {
          "ThumbnailUrl": "string",
          "ThumbnailUrlExpiration": "2023-09-26T15:38:17.419Z",
          "Id": 0,
          "Name": "string",
          "Size": 0,
          "Date": "2023-09-26T15:38:17.419Z",
          "Url": "string",
          "UrlExpiration": "2023-09-26T15:38:17.419Z"
        },
        "PerspectiveCamera": {
          "CameraPosition": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "CameraDirection": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "CameraUpVector": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "FieldOfView": 0
        },
        "OrthogonalCamera": {
          "CameraPosition": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "CameraDirection": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "CameraUpVector": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "ViewToWorldScale": 0,
          "Height": 0,
          "Width": 0
        },
        "Pinpoint": {
          "Name": "string",
          "Position": {
            "X": 0,
            "Y": 0,
            "Z": 0
          },
          "Element1": {
            "IfcGuid": "string",
            "OriginatingSystem": "string",
            "AuthoringToolId": "string",
            "Filename": "string",
            "DocumentGuid": "string"
          },
          "Element2": {
            "IfcGuid": "string",
            "OriginatingSystem": "string",
            "AuthoringToolId": "string",
            "Filename": "string",
            "DocumentGuid": "string"
          }
        },
        "Source": "Unspecified",
        "ViewName": "string",
        "ModelName": "string",
        "Comments": [
          {
            "Id": 0,
            "Author": {
              "Id": 0,
              "UserName": "string",
              "Email": "string",
              "FirstName": "string",
              "LastName": "string",
              "AvatarUrl": "string"
            },
            "CreationDate": "2023-09-26T15:38:17.419Z",
            "Comment": "string",
            "UniqueId": "string"
          }
        ],
        "ViewUniqueId": "string",
        "ViewerUrl": "string",
        "WasCreatedFromSheetInstance": true,
        "ViewStateSummary": {
          "ClipMode": "None",
          "ClippingPlanes": [
            {
              "Location": {
                "X": 0,
                "Y": 0,
                "Z": 0
              },
              "Direction": {
                "X": 0,
                "Y": 0,
                "Z": 0
              }
            }
          ],
          "SectionBox": {
            "Center": {
              "X": 0,
              "Y": 0,
              "Z": 0
            },
            "Rotation": {
              "X": 0,
              "Y": 0,
              "Z": 0
            },
            "Size": {
              "X": 0,
              "Y": 0,
              "Z": 0
            }
          },
          "HasHiddenElements": true,
          "HasSelectedElements": true
        }
      }
    ],
    "IsRestricted": true,
    "ViewerUrl": "string",
    "AttributesToHighlight": [
      "string"
    ]
  }
]

Changelog

Newforma Konekt Web API 2024-12-02

Newforma Konekt Web API 2023-10-30

Newforma Konekt Web API 2023-02-03