**Utility Data Batch Info** records the source and label of a batch of imported utility data. Create one and reference it (via `batch_info_uuid`) when writing meters, readings or consumption intervals to group them under an import; it cannot be changed once created.
openapi: 3.1.0
info:
description: '
## Introduction
The **CAPEX API** enables you to integrate your application with the CAPEX system. The CAPEX API is REST-based and follows JSON:API principles for structuring responses.
Starting from version 1.0, the API is stable. We are continuously improving our API, and new endpoints will be added. Any updates or changes within this major version will be backward-compatible and can be found in this documentation.
For getting access to the CAPEX API, please reach out to us at: `kontakt@alasco.de`.
The base URL for all endpoints is:
`https://api.alasco.de/capex/v1`
The CAPEX API supports compressed payloads. If you would like to make use of this, you have to specify the `Accept-Encoding` header. Supported encodings are `gzip` and `br`.
### Domain model
Objects relate as follows (each `→` is a navigable sub-resource):
- **Assets** and **Measures** are the CapEx-specific top-level objects; a **Measure** → **Contracts**, and invoices are submitted against an **Asset**.
- **Contractor** and **Contracting Entity** → **Contracts**.
- **Contract** → **Change Orders**, **Invoices**, contract terms, **Documents** and **Custom Fields**.
- **Invoice** → **Documents** and **Tags** (Change Orders also carry **Documents**).
### CAPEX API Overview
The CAPEX API provides endpoints to:
- Retrieve and manage invoices, invoice tags, and invoice documents
- Retrieve assets, contracts, contractors, and measures
The CAPEX API uses pagination. The page size is 100, and additional pages can be accessed using a `next` link.
'
title: CAPEX Annual Consumption Utility Data Batch Info API
version: '1.0'
x-logo:
url: https://assets-global.website-files.com/656ef2eb27ad41897248f866/659eebec190ae7aaf4162f09_Logotype_Alasco_white_RGB%202.png
servers:
- url: https://api.alasco.de/capex/v1
tags:
- description: '**Utility Data Batch Info** records the source and label of a batch of imported utility data. Create one and reference it (via `batch_info_uuid`) when writing meters, readings or consumption intervals to group them under an import; it cannot be changed once created.'
name: Utility Data Batch Info
paths:
/utility-data-batch-info/:
post:
operationId: add_utility_data_batch_info_utility_data_batch_info__post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UtilityDataBatchInfoPayload'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/UtilityDataBatchInfoResponse'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- API Key: []
- API Token: []
summary: Add Utility Data Batch Info
tags:
- Utility Data Batch Info
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
UtilityDataBatchInfoPayload:
properties:
data:
$ref: '#/components/schemas/alasco__public_api__esg__web__v1__schemas__utilities__utility_batch_info__UtilityDataBatchInfoWrite'
required:
- data
title: UtilityDataBatchInfoPayload
type: object
alasco__ivy__public__api__utilities__utility_data_batch_info__UtilityDataBatchInfoWrite:
properties:
data_source_label:
title: Data Source Label
type: string
data_source_value:
title: Data Source Value
type: string
external_id:
anyOf:
- type: string
- type: 'null'
title: External Id
required:
- data_source_value
- data_source_label
title: UtilityDataBatchInfoWrite
type: object
alasco__public_api__esg__web__v1__schemas__utilities__utility_batch_info__UtilityDataBatchInfoWrite:
properties:
attributes:
$ref: '#/components/schemas/alasco__ivy__public__api__utilities__utility_data_batch_info__UtilityDataBatchInfoWrite'
type:
const: UTILITY_DATA_BATCH_INFO
default: UTILITY_DATA_BATCH_INFO
title: Type
type: string
required:
- attributes
title: UtilityDataBatchInfoWrite
type: object
BaseDataSchema:
properties:
attributes:
anyOf:
- {}
- type: 'null'
title: Attributes
id:
format: uuid
title: Id
type: string
relationships:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Relationships
type:
$ref: '#/components/schemas/ResourceType'
required:
- id
- type
title: BaseDataSchema
type: object
ResourceType:
enum:
- BUILDING
- UTILITY_METER
- UTILITY_METER_IMPORT
- UTILITY_METER_READING
- CONSUMPTION_INTERVAL
- UTILITY_DATA_BATCH_INFO
- AUDIT_LOG
- USER_AUDIT_LOG
- DOCUMENT_EVENT
- FILE
- FILE_EXTERNAL_ID
- FILE_METADATA
- ANALYSIS_RESULT
- TENANT
- TENANT_ATTACHMENT
- CUSTOM_DATA_GROUP_INSTANCE
- ANNUAL_CONSUMPTION
- TENANT_CONSUMPTION_LINK
title: ResourceType
type: string
Error:
properties:
code:
anyOf:
- type: string
- type: 'null'
title: Code
detail:
anyOf:
- type: string
- type: 'null'
title: Detail
source:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
title: Source
status:
anyOf:
- type: string
- type: 'null'
title: Status
title:
anyOf:
- type: string
- type: 'null'
title: Title
title: Error
type: object
ValidationError:
properties:
ctx:
title: Context
type: object
input:
title: Input
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
UtilityDataBatchInfoData:
properties:
attributes:
$ref: '#/components/schemas/UtilityDataBatchInfoAttributes'
id:
format: uuid
title: Id
type: string
relationships:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Relationships
type:
const: UTILITY_DATA_BATCH_INFO
default: UTILITY_DATA_BATCH_INFO
title: Type
type: string
required:
- id
- attributes
title: UtilityDataBatchInfoData
type: object
UtilityDataBatchInfoResponse:
properties:
data:
$ref: '#/components/schemas/UtilityDataBatchInfoData'
errors:
anyOf:
- items:
$ref: '#/components/schemas/Error'
type: array
- type: 'null'
title: Errors
included:
anyOf:
- items:
$ref: '#/components/schemas/BaseDataSchema'
type: array
- type: 'null'
title: Included
links:
anyOf:
- $ref: '#/components/schemas/Links'
- type: 'null'
required:
- data
title: UtilityDataBatchInfoResponse
type: object
UtilityDataBatchInfoAttributes:
properties:
data_source_label:
description: '**Data source label** · **Datenquelle (Bezeichnung)**'
title: Data Source Label
type: string
data_source_value:
description: '**Data source value** · **Datenquelle (Wert)**'
title: Data Source Value
type: string
external_id:
anyOf:
- type: string
- type: 'null'
description: '**External ID** · **Externe ID**'
title: External Id
required:
- external_id
- data_source_value
- data_source_label
title: UtilityDataBatchInfoAttributes
type: object
Links:
properties:
next:
anyOf:
- type: string
- type: 'null'
title: Next
prev:
anyOf:
- type: string
- type: 'null'
title: Prev
required:
- next
- prev
title: Links
type: object
securitySchemes:
API Key:
description: '
The Alasco API uses a combination of API keys and API tokens to authenticate requests. The API key
needs to be sent in a header field called `X-API-KEY`.
'
in: header
name: X-API-KEY
type: apiKey
API Token:
description: '
In addition to an API key, one has to specify an API token. There can be one or more tokens in use
for the same API key. The token needs to be sent in a header field called `X-API-TOKEN`.
Right now, it''s not possible to create API keys and API tokens from within Alasco.
If you are interested in using the Alasco API, please reach out to the
[support team](mailto:support@alasco.de). They will assist you in generating a key and token pair.
'
in: header
name: X-API-TOKEN
type: apiKey