Change an item type
PATCH
/service-item-types/{id}
const url = 'https://example.com/service-item-types/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';const options = { method: 'PATCH', headers: { cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>', 'Content-Type': 'application/json' }, body: '{"name":"example","fields":[{"id":"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f","name":"example","valueType":"text","required":false,"unique":false,"pattern":"example","hint":"example"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/service-item-types/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \ --header 'Content-Type: application/json' \ --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \ --data '{ "name": "example", "fields": [ { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "name": "example", "valueType": "text", "required": false, "unique": false, "pattern": "example", "hint": "example" } ] }'Renames the type or replaces its details. Give a detail its id to keep the values recorded under it; a detail left out is removed from the form, and its values stay on the items. A date detail a service plan counts from cannot be renamed or removed until the plan is changed.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
UUID v7
string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fUUID v7
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
name
string
fields
Array<object>
object
id
UUID v7
string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8fname
required
string
valueType
required
string
required
boolean
unique
boolean
pattern
string | null
hint
string | null
Responses
Section titled “Responses”Changed
Media typeapplication/json
object
id
required
UUID v7
string format: uuid
name
required
string
fields
required
Array<object>
object
id
required
UUID v7
string format: uuid
name
required
string
valueType
required
string
required
required
boolean
unique
required
boolean
pattern
required
string | null
hint
required
string | null
itemCount
required
integer
Example
{ "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "name": "Regulator", "fields": [ { "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "name": "Serial number", "valueType": "text" } ]}Not signed in
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not an owner or admin, missing scope, or the plan does not open Equipment servicing
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Not found, or Equipment servicing is not available to this business
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up
Media typeapplication/json
object
error
required
string
message
required
string
Example
{ "error": "not_found", "message": "Customer not found"}Validation failed
Media typeapplication/json
object
error
required
string
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{ "error": "validation", "issues": [ { "path": "email", "message": "Invalid email" } ]}