Skip to main content

Points

Points represent individual items in lists that need attention or action. They are the core entities that track issues, tasks, and observations in projects.

📖 Point Reference

Point Queries​

Get All Points for a Project​

Retrieve all points for a specific project:

query GetProjectPoints($projectID: UUID!, $afterId: UUID, $pageSize: Int) {
  points(projectID: $projectID, afterId: $afterId, pageSize: $pageSize) {
    id
    projectId
    project {
      id
      name
      code
    }
    codeNum
    code
    subject
    date
    category {
      code
      description
    }
    isArchived
    isUrgent
    dueDate
    archivedDate
    listId
    inCharge {
      userId
      tag
    }
    authorId
    author {
      id
      displayName
    }
    problemLocation
    entityVersion
    status {
      id
      code
      color
      name
    }
    lastModificationUserId
    hasAttachment
    customFields {
      id
      fieldId
      fieldName
      value
    }
  }
}

Variables:

{
  "projectID": "123e4567-e89b-12d3-a456-426614174000",
  "pageSize": 50
}

Get Single Point​

Retrieve a specific point by ID:

query GetPoint($id: UUID!) {
  point(id: $id) {
    id
    projectId
    project {
      id
      name
      code
    }
    codeNum
    code
    subject
    date
    category {
      code
      description
    }
    isArchived
    isUrgent
    dueDate
    archivedDate
    listId
    inCharge {
      userId
      tag
    }
    authorId
    author {
      id
      displayName
    }
    problemLocation
    entityVersion
    status {
      id
      code
      color
      name
    }
    lastModificationUserId
    hasAttachment
    customFields {
      id
      fieldId
      fieldName
      value
    }
  }
}

Search Points​

Search for points using filters:

query SearchPoints($filter: SearchPointFilter!, $afterId: UUID, $pageSize: Int) {
  searchPoints(filter: $filter, afterId: $afterId, pageSize: $pageSize) {
    id
    subject
    code
    codeNum
    date
    isArchived
    isUrgent
    dueDate
    status {
      name
      color
    }
    category {
      description
    }
    project {
      name
      code
    }
  }
}

Variables:

{
  "filter": {
    "_And": [
      {
        "subject": {
          "contains": "Safety"
        }
      },
      {
        "isArchived": {
          "equals": false
        }
      },
      {
        "projectId": {
          "equals": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      {
        "statusId": {
          "equals": "456e7890-e89b-12d3-a456-426614174001"
        }
      }
    ]
  },
  "pageSize": 50
}

Point Mutations​

Create Point​

Create a new point within a list:

mutation CreatePoint($point: CreatePointInput!) {
  createPoint(point: $point) {
    id
  }
}

Variables:

{
  "point": {
    "listId": "456e7890-e89b-12d3-a456-426614174001",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "isUrgent": true,
    "subject": "Missing safety railing on third floor",
    "roomId": "789e0123-e89b-12d3-a456-426614174002",
    "dueDate": "2024-02-15T00:00:00Z",
    "categoryId": "012e3456-e89b-12d3-a456-426614174003",
    "statusId": "345e6789-e89b-12d3-a456-426614174004",
    "comment": "Safety hazard that needs immediate attention",
    "customFields": [
      {
        "id": "678e9012-e89b-12d3-a456-426614174005",
        "value": "High Priority"
      }
    ]
  }
}

Note: Points are created individually. For multiple points, create them one by one using the createPoint mutation.

Next Steps​

Now that you understand point operations: