Skip to main content

UPowr Job Type API (1.0.0)

Download OpenAPI specification:Download

Create a new job type

Authorizations:
session
Request Body schema: application/json
required
code
required
string

The code of the Job Type.

name
required
string

The name of the Job Type.

workflow
required
string
Enum: "inspection" "installation"

The workflow of the Job Type.

projectTypes
required
Array of strings
Items Enum: "SALES" "SERVICE"

A list of project types for filtering purposes.

description
string

A description of the Job Type.

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "workflow": "inspection",
  • "projectTypes": [
    ],
  • "description": "string"
}

Response samples

Content type
application/json

Job Type created

{
  • "id": "ABC123456DE"
}

Update an existing Job Type

Authorizations:
session
path Parameters
jobTypeId
required
string <uuid>

The Job Type id

Request Body schema: application/json
required
name
string

The name of the Job Type.

workflow
string
Enum: "inspection" "installation"

The workflow of the Job Type.

projectTypes
Array of strings
Items Enum: "SALES" "SERVICE"

A list of project types for filtering purposes.

description
string

A description of the Job Type.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "workflow": "inspection",
  • "projectTypes": [
    ],
  • "description": "string"
}

Response samples

Content type
application/json

Job Type actioned

{
  • "ok": true
}