> ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Change service ticket state to Done > Changes the service ticket state to Done. ## OpenAPI ````json POST /api/v1/maintenance/servicetickets/done { "openapi": "3.0.4", "info": { "title": "Maintenance V1", "description": "# Maintenance API Documentation\nWelcome to BETA version of the new Maintenance API - intended for client public testing before the launch of the final version. During this BETA phase, we'll be improving the API based on specific client's feedbacks.\n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## Operations \n\nThe API supports operations for the following: \n\n- **Service Tickets**\n\nFor each type, you can: \n\n- **GET**: Retrieve a list or apply filters.", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Metadata" }, { "name": "ServiceTickets" } ], "paths": { "/api/v1/maintenance/servicetickets/done": { "post": { "tags": [ "ServiceTickets" ], "summary": "Change service ticket state to Done", "description": "Changes the service ticket state to Done.", "operationId": "ChangeServiceTicketStateToDone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketStateToDone" } } } }, "responses": { "200": { "description": "The service ticket state was changed to Done", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketDetails" } } } }, "400": { "description": "The service ticket state change has validation issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } }, "404": { "description": "There was a problem changing the state of the service ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorMessageModel" } } } } }, "x-d360-narrative-url": "

Change service ticket state to Done

This endpoint sets the state of an existing service ticket to Done, closing it out.

The ticket is identified by its internal reference, its external identifier, or both.

Request Fields

Field

Type

Required

Description

reference

string

Conditional

Internal identifier of the service ticket to close. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

externalIdentifier

string

Conditional

External identifier of the service ticket to close, as set by the integrating system. Either reference or externalIdentifier must be provided. If both are given, the ticket must match both values.

closingDate

string (date-time)

No

Date and time the ticket was closed. If omitted, Bloxs populates this automatically depending on configuration. Used for reporting on process duration. ISO 8601 format.

Response Fields

Field

Type

Required

Description

reference

string

Yes

Internal identifier of the service ticket, generated by Bloxs.

externalIdentifier

string

No

External identifier of the ticket, as set by the integrating system.

externalLink

string

No

URL of the ticket in a system outside of Bloxs.

reportingDate

string (date)

Yes

Date the ticket was created.

stateName

string

Yes

Name of the ticket's current state. Expected to reflect the Done state after this operation.

priority

integer

Yes

Priority of the report. Valid values are 1 (Low), 2 (Normal), or 3 (High).

problemCategoryName

string

No

Problem category the ticket belongs to.

costsAreForTenant

boolean

No

Indicates whether the tenant is responsible for the costs of the ticket.

costCategoryName

string

No

Cost category of the ticket.

description

string

Yes

Description of the reported problem.

realEstateObjectReference

string

Yes

Reference of the real estate object the ticket applies to.

reporterReference

string

Yes

Reference of the relation to contact regarding the ticket.

reporterContactPersonReference

string

No

Reference of the contact person for communication about the ticket.

reporterExternalContactPersonName

string

No

Name of the contact person, if not registered in Bloxs.

reporterExternalContactPersonPhoneNumber

string

No

Phone number of the contact person, if not registered in Bloxs.

reporterExternalContactPersonMobileNumber

string

No

Mobile phone number of the contact person, if not registered in Bloxs.

reporterExternalContactPersonEmail

string

No

Email address of the contact person, if not registered in Bloxs.

supplierReference

string

No

Reference of the supplier handling the ticket.

handledBySupplier

boolean

No

Indicates whether the supplier has accepted responsibility for resolving the ticket.

expectedCosts

number (double)

No

Estimated cost for resolving the issue.

mandateAmount

number (double)

No

Maximum amount for which the supplier has the mandate to resolve the issue underlying the ticket.

disableUIMutations

boolean

No

Indicates whether changes to the ticket are disabled in the Bloxs application.

disableSystemTasks

boolean

No

Indicates whether the system tasks triggered by the ticket's priority are disabled.

disableSystemCorrespondence

boolean

No

Indicates whether automatic system-generated correspondence for the ticket is disabled.

isVisibleInPortal_Owner

boolean

Yes

Indicates whether the ticket is visible in the Owner Portal.

isVisibleInPortal_Tenant

boolean

Yes

Indicates whether the ticket is visible in the Tenant Portal.

" } } }, "components": { "schemas": { "ServiceTicketStateToDone": { "type": "object", "properties": { "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ServiceTicketDetails": { "required": [ "description", "priority", "realEstateObjectReference", "reference", "reporterReference", "reportingDate", "stateName" ], "type": "object", "properties": { "externalIdentifier": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "externalLink": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "reportingDate": { "type": "string", "format": "date" }, "stateName": { "maxLength": 256, "minLength": 0, "type": "string" }, "priority": { "type": "integer", "description": "Low = 1\nNormal = 2\nHigh = 3", "format": "int32", "x-enumNames": [ "Low", "Normal", "High" ] }, "problemCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "costsAreForTenant": { "type": "boolean" }, "costCategoryName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "description": { "minLength": 1, "type": "string" }, "realEstateObjectReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "reporterReference": { "maxLength": 100, "minLength": 0, "type": "string" }, "reporterContactPersonReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonName": { "maxLength": 256, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonPhoneNumber": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonMobileNumber": { "maxLength": 512, "minLength": 0, "type": "string", "nullable": true }, "reporterExternalContactPersonEmail": { "maxLength": 254, "minLength": 0, "type": "string", "nullable": true }, "supplierReference": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "handledBySupplier": { "type": "boolean" }, "expectedCosts": { "type": "number", "format": "double", "nullable": true }, "reference": { "maxLength": 100, "minLength": 0, "type": "string" }, "mandateAmount": { "type": "number", "format": "double", "nullable": true }, "disableUIMutations": { "type": "boolean" }, "disableSystemTasks": { "type": "boolean" }, "disableSystemCorrespondence": { "type": "boolean" }, "isVisibleInPortal_Owner": { "type": "boolean" }, "isVisibleInPortal_Tenant": { "type": "boolean" } }, "additionalProperties": false }, "APIErrorMessageModel": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "traceId": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" }, "nullable": true }, "nullable": true } }, "additionalProperties": false } } } } ````