Assembly Instruction Step Requirement

The assembly instruction step requirement resource.

Basehttps://rest.carbon.ms/assemblyInstructionStepRequirement

GET/assemblyInstructionStepRequirement

List assembly instruction step requirements

Retrieve a paginated list of assembly instruction step requirements. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/assemblyInstructionStepRequirement

curl --request GET \
  --url 'https://rest.carbon.ms/assemblyInstructionStepRequirement?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "stepId": "xyz789",
    "type": "string",
    "name": "Example",
    "quantity": 10,
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdBy": "string"
  }
]

GET/assemblyInstructionStepRequirement

Retrieve a assembly instruction step requirement

Fetch a single assembly instruction step requirement by filtering on `id`.

Query parameters

idstring

Match on the assembly instruction step requirement's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/assemblyInstructionStepRequirement

curl --request GET \
  --url 'https://rest.carbon.ms/assemblyInstructionStepRequirement?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "type": "string",
  "name": "Example",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

POST/assemblyInstructionStepRequirement

Create a assembly instruction step requirement

Create a new assembly instruction step requirement.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

typeassemblyRequirementTyperequired

itemIdstring

References item.id

namestring

textstring

severityassemblyNoteSeverity

filePathstring

quantitynumberrequired

sortOrdernumberrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/assemblyInstructionStepRequirement

curl --request POST \
  --url https://rest.carbon.ms/assemblyInstructionStepRequirement \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"stepId":"xyz789","type":"string","name":"Example","quantity":10,"sortOrder":0,"companyId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "type": "string",
  "name": "Example",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

PATCH/assemblyInstructionStepRequirement

Update a assembly instruction step requirement

Update an existing assembly instruction step requirement, matched on `id`.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

typeassemblyRequirementTyperequired

itemIdstring

References item.id

namestring

textstring

severityassemblyNoteSeverity

filePathstring

quantitynumberrequired

sortOrdernumberrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/assemblyInstructionStepRequirement

curl --request PATCH \
  --url 'https://rest.carbon.ms/assemblyInstructionStepRequirement?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"stepId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "type": "string",
  "name": "Example",
  "quantity": 10,
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string"
}

DELETE/assemblyInstructionStepRequirement

Delete a assembly instruction step requirement

Delete a assembly instruction step requirement, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the assembly instruction step requirement to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/assemblyInstructionStepRequirement

curl --request DELETE \
  --url 'https://rest.carbon.ms/assemblyInstructionStepRequirement?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content