Inventory | Service Instance Attachments

List attachments of a service instance (customer view)

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

Responses

200

OK: List of attachments.

application/json

totalinteger · int32Required

401

Unauthorized

application/json

403

Forbidden

application/json

get/v1/inventory/service-instances/{instanceId}/attachments

HTTPcURLJavaScriptPython

GET /v1/inventory/service-instances/{instanceId}/attachments HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "fileName": "text",
      "contentType": "text",
      "size": 1,
      "scope": "text",
      "note": "text",
      "created": "2026-08-07T17:53:51.896Z",
      "authorTenantUuid": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "modifiedBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "content": {
        "href": "text",
        "method": "text"
      },
      "id": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Upload one or more attachments to a service instance (customer view)

post

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

Body

multipart/form-data

Filesstring · binary[]Required

One or more files to upload — max 20 MB of total content per request (e.g. one 20 MB file or several smaller files, max 20 files), max 200 per owner overall. Upload several large files in separate requests.

Scopestring · enumOptional

Defines who can see an attachment. public: visible to all tenants with access to the owner | internal: visible only to the author tenant.

Possible values:

Notestring · max: 500Optional

Optional shared note for all files in the batch.

Responses

201

Created: The created attachment list.

application/json

totalinteger · int32Required

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post/v1/inventory/service-instances/{instanceId}/attachments

HTTPcURLJavaScriptPython

POST /v1/inventory/service-instances/{instanceId}/attachments HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 51

{
  "Files": [
    "binary"
  ],
  "Scope": "public",
  "Note": "text"
}

{
  "items": [
    {
      "fileName": "text",
      "contentType": "text",
      "size": 1,
      "scope": "text",
      "note": "text",
      "created": "2026-08-07T17:53:51.896Z",
      "authorTenantUuid": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "modifiedBy": {
        "id": 4,
        "firstName": "Pierce",
        "lastName": "Bell",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "content": {
        "href": "text",
        "method": "text"
      },
      "id": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single attachment of a service instance (customer view)

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

idinteger · int32Required

The identifier of the attachment.

Responses

200

OK: The attachment.

application/json

fileNamestring · nullableOptional

Original filename as supplied by the uploader.

contentTypestring · nullableOptional

Sniffed MIME type.

sizeinteger · int64Optional

File size in bytes.

scopestring · nullableOptional

Visibility scope: "public" or "internal".

notestring · nullableOptional

Optional note.

createdstring · date-timeOptional

Upload timestamp (UTC).

authorTenantUuidstring · uuidOptional

Tenant SID of the customer who uploaded this attachment. Clients use this to determine whether PATCH/DELETE is permitted (author-tenant only).

idinteger · int32Required

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get/v1/inventory/service-instances/{instanceId}/attachments/{id}

HTTPcURLJavaScriptPython

GET /v1/inventory/service-instances/{instanceId}/attachments/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "fileName": "text",
  "contentType": "text",
  "size": 1,
  "scope": "text",
  "note": "text",
  "created": "2026-08-07T17:53:51.896Z",
  "authorTenantUuid": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": {
    "id": 4,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "[e-mail]",
    "username": "[e-mail]",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "modifiedBy": {
    "id": 4,
    "firstName": "Pierce",
    "lastName": "Bell",
    "email": "[e-mail]",
    "username": "[e-mail]",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "content": {
    "href": "text",
    "method": "text"
  },
  "id": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Delete an attachment (customer view, author tenant only)

delete

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

idinteger · int32Required

The identifier of the attachment.

Responses

204

NoContent: Delete successful.

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not found

text/plainapplication/jsontext/json

delete/v1/inventory/service-instances/{instanceId}/attachments/{id}

HTTPcURLJavaScriptPython

DELETE /v1/inventory/service-instances/{instanceId}/attachments/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Update scope, note or filename of an attachment (customer view, author tenant only)

patch

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

idinteger · int32Required

The identifier of the attachment.

Bodyobject · Operation[]

application/json-patch+jsonapplication/json

valueany · nullableOptional

pathstring · nullableOptional

opstring · nullableOptional

fromstring · nullableOptional

Responses

204

NoContent: Update successful.

No content

400

Bad request

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not found

text/plainapplication/jsontext/json

patch/v1/inventory/service-instances/{instanceId}/attachments/{id}

HTTPcURLJavaScriptPython

PATCH /v1/inventory/service-instances/{instanceId}/attachments/{id} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 56

[
  {
    "value": null,
    "path": "text",
    "op": "text",
    "from": "text"
  }
]

application/json-patch+jsonapplication/json

No content

Stream the content of an attachment (customer view)

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

instanceIdinteger · int32Required

The identifier of the service instance.

idinteger · int32Required

The identifier of the attachment.

Responses

200

OK: The file content.

No content

401

Unauthorized

text/plainapplication/jsontext/json

403

Forbidden

text/plainapplication/jsontext/json

404

Not found

text/plainapplication/jsontext/json

get/v1/inventory/service-instances/{instanceId}/attachments/{id}/download

HTTPcURLJavaScriptPython

GET /v1/inventory/service-instances/{instanceId}/attachments/{id}/download HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content