Create a QC inspection set

POST

qc-inspection-set

curl --request POST \
  --url https://{instance}/api/v2/qc-inspection-set \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase": "<string>",
  "assignees": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "approvers": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "category": "<string>",
  "subcategory": "<string>",
  "isReworked": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    rootDeliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    deliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    stageId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    phase: '<string>',
    assignees: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    approvers: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    category: '<string>',
    subcategory: '<string>',
    isReworked: false,
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{instance}/api/v2/qc-inspection-set', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/qc-inspection-set"

payload = {
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phase": "<string>",
    "assignees": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "approvers": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "category": "<string>",
    "subcategory": "<string>",
    "isReworked": False,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "value": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phase": "<string>",
    "assignees": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "approvers": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "category": "<string>",
    "subcategory": "<string>",
    "isReworked": false,
    "triggerKey": "deliverable.reworked",
    "status": "pending",
    "latestReviewedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latestCreatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

Authorizations

X-API-Key

string

header

required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Body

application/json

object
object[]

templateId

string<uuid>

required

QC template version the set was filled from.

string<uuid>

Unique id. Generated on create unless you supply one.

rootDeliverableId

string<uuid> | null

Root order the set belongs to. Set to null if that order is ever deleted.

deliverableId

string<uuid> | null

Deliverable the set was inspected against. Set to null if that node is ever deleted.

stageId

string<uuid> | null

Station the set was inspected at. Set to null if that station is ever deleted.

projectId

string<uuid> | null

Project the set belongs to. Set to null if that project is ever deleted.

phase

string | null

Phase name captured when the set was created.

assignees

string<uuid>[]

People asked to fill the form. Defaults to empty.

Person id.

approvers

string<uuid>[]

People who can approve the result. Defaults to empty.

Person id.

Response

The created QC inspection set. An array request returns values instead of value.

Option 1
Option 2

value

object

required

One filled-out QC form: which template was used, what it was inspected against, and how it came out.

Show child attributes

Create a QC inspection set

curl --request POST \
  --url https://{instance}/api/v2/qc-inspection-set \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase": "<string>",
  "assignees": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "approvers": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "category": "<string>",
  "subcategory": "<string>",
  "isReworked": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    templateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    rootDeliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    deliverableId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    stageId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    phase: '<string>',
    assignees: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    approvers: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    category: '<string>',
    subcategory: '<string>',
    isReworked: false,
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{instance}/api/v2/qc-inspection-set', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{instance}/api/v2/qc-inspection-set"

payload = {
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phase": "<string>",
    "assignees": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "approvers": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "category": "<string>",
    "subcategory": "<string>",
    "isReworked": False,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "value": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "rootDeliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deliverableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "stageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phase": "<string>",
    "assignees": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "approvers": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "category": "<string>",
    "subcategory": "<string>",
    "isReworked": false,
    "triggerKey": "deliverable.reworked",
    "status": "pending",
    "latestReviewedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "latestCreatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ],
    "missingPermissions": [
      "<string>"
    ]
  },
  "context": {}
}

Overview

Projects

Stages

Deliverables

Work sessions

Dependencies

Documents

Custom properties

QC

People (Workers)

Timesheets

Codes

Roles

Users

Domain concepts

Items

Item vendors

Inventory stock

Inventory transactions

Inventory allocations

BOM lines

Production outputs

Units of measure

Vendors

Locations

Deliveries

Delivery lines

Trucks

Contacts

Project contacts

Teams

Shifts

Departments (shops)

Authorizations

Body

Response