BeeCollect Cloud API

SelectData

Startseite Zurück zur BeeCollect Cloud API

Beschreibung

Ruft Daten-Elemente aus dem mit dem ShareKey assoziierten Core ab. Geliefert werden nur Datenelemente, auf welche mindestens Lesezugriff basierend auf dem übergebenen ShareKey besteht.

Aufruf

https://beecollect.cloud/api/v1/SelectData

Methode

  • GET

Authentifizierung

  • HTTP Basic Auth (Benutzer und Kennwort wird von Solvatec bereitgestellt)
  • X-Access-Token Header

Parameter

Alle Parameter werden als benannte Header erwartet.

Parameter Beschreibung
X-Access-Token Gültiges Access-Token (siehe GetAccessToken)
Share-Key Gültiger Schlüssel der Organisation, mit der Daten geteilt werden sollen (wird von der jeweiligen Organisation bereitgestellt)
Format Format, in dem die Daten bereitgestellt werden sollen. (siehe unten)
Data-Element-Key Gültiger Datenelement-Schlüssel als GUID (bei Abruf bestimmter Datenelemente)
Changed Nur unveränderte Datenelemente (0) / geänderte Datenelemente (1) abrufen. (bei Abfrage mehrerer Datenelemente)
Start Nummer des ersten zu liefernden Elements. (bei Abfrage mehrerer Datenelemente)
Count Anzahl der zu liefernden Elemente (maximal 1.000). (bei Abfrage mehrerer Datenelemente)
Reset-Flag Bei Datenelementen mit gesetztem Flag wird dieses nach erfolgreichem Abruf automatisch zurückgesetzt (1) (optional)

Rückgabewert

  • Abhängig von gewählten Format: JSON-Response / XML-Response
[
  {
    "Responsible_Name": "string",
    "Responsible_Key": "string",
    "Responsible_Uri": "string",
    "Responsible_ContactPerson": "string",
    "Responsible_PhoneNumber": "string",
    "Responsible_Email": "string",
    "Responsible_Website": "string",
    "CreationDate": "2025-12-03T10:39:05.150Z",
    "ChangeDate": "2025-12-03T10:39:05.150Z",
    "SearchEnabled_Intern": true,
    "SearchEnabled_Web": true,
    "MetaDataFormat": "bc_json",
    "OaiPmhSet": "string",
    "ModuleName": "collection",
    "ModuleKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ContainerName": "string",
    "ContainerKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ItemKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ItemUri": "string",
    "PrimaryIdentifier": "string",
    "Name": "string",
    "Description": "string",
    "Keywords": [
      "string"
    ],
    "ExternalContent": "string",
    "Fields_Text": [
      {
        "FieldType": "Text",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "Value": "string"
      }
    ],
    "Fields_Integer": [
      {
        "FieldType": "Integer",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "Value": 0
      }
    ],
    "Fields_Float": [
      {
        "FieldType": "Float",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "Value": 0.1
      }
    ],
    "Fields_DateTime": [
      {
        "FieldType": "DateTime",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "Value": "2025-12-03T10:39:05.150Z"
      }
    ],
    "Fields_Boolean": [
      {
        "FieldType": "Boolean",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "Value": true
      }
    ],
    "Fields_Reference": [
      {
        "FieldType": "Reference",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "CreationDate": "2025-12-03T10:39:05.150Z",
        "ChangeDate": "2025-12-03T10:39:05.150Z",
        "ModuleName": "collection",
        "ModuleKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ContainerName": "string",
        "ContainerKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ItemKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "ItemUri": "string",
        "ReferenceType": "string",
        "Text": "string",
        "Attribute": "string",
        "Status": "string",
        "Verification": "string",
        "Description": "string",
        "Fields_Text": [
          {
            "FieldType": "Text",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Value": "string"
          }
        ],
        "Fields_Integer": [
          {
            "FieldType": "Integer",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Value": 0
          }
        ],
        "Fields_Float": [
          {
            "FieldType": "Float",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Value": 0.1
          }
        ],
        "Fields_DateTime": [
          {
            "FieldType": "DateTime",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Value": "2025-12-03T10:39:05.150Z"
          }
        ],
        "Fields_Boolean": [
          {
            "FieldType": "Boolean",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Value": true
          }
        ],
        "Fields_TypedString": [
          {
            "FieldType": "TypedString",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "ValueType": "string",
            "Text": "string",
            "Attribute": "string",
            "Status": "string",
            "Verification": "string",
            "Description": "string"
          }
        ],
        "Fields_Dimension": [
          {
            "FieldType": "Dimension",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "DimensionType": "string",
            "Text": "string",
            "Prefix": "string",
            "Suffix": "string",
            "Dimension1": 0.1,
            "Dimension2": 0.1,
            "Dimension3": 0.1,
            "Measure": "string",
            "Description": "string"
          }
        ],
        "Fields_Dating": [
          {
            "FieldType": "Dating",
            "FieldName": "string",
            "Label": "string",
            "Language": "string",
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "DatingType": "string",
            "Text": "string",
            "YearFrom": 0,
            "MonthFrom": 0,
            "DayFrom": 0,
            "YearTo": 0,
            "MonthTo": 0,
            "DayTo": 0,
            "Attribute": "string",
            "Status": "string",
            "Verification": "string",
            "Description": "string"
          }
        ],
        "Lists": [
          {
            "ListName": "string",
            "ListKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "Language": "string",
            "Label": "string",
            "Items": [
              {
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Language": "string",
                "Fields_Text": [
                  {
                    "FieldType": "Text",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "Value": "string"
                  }
                ],
                "Fields_Integer": [
                  {
                    "FieldType": "Integer",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "Value": 0
                  }
                ],
                "Fields_Float": [
                  {
                    "FieldType": "Float",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "Value": 0.1
                  }
                ],
                "Fields_DateTime": [
                  {
                    "FieldType": "DateTime",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "Value": "2025-12-03T10:39:05.151Z"
                  }
                ],
                "Fields_Boolean": [
                  {
                    "FieldType": "Boolean",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "Value": true
                  }
                ],
                "Fields_Reference": [
                  "string"
                ],
                "Fields_TypedString": [
                  {
                    "FieldType": "TypedString",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "ValueType": "string",
                    "Text": "string",
                    "Attribute": "string",
                    "Status": "string",
                    "Verification": "string",
                    "Description": "string"
                  }
                ],
                "Fields_Dimension": [
                  {
                    "FieldType": "Dimension",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "DimensionType": "string",
                    "Text": "string",
                    "Prefix": "string",
                    "Suffix": "string",
                    "Dimension1": 0.1,
                    "Dimension2": 0.1,
                    "Dimension3": 0.1,
                    "Measure": "string",
                    "Description": "string"
                  }
                ],
                "Fields_Dating": [
                  {
                    "FieldType": "Dating",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "DatingType": "string",
                    "Text": "string",
                    "YearFrom": 0,
                    "MonthFrom": 0,
                    "DayFrom": 0,
                    "YearTo": 0,
                    "MonthTo": 0,
                    "DayTo": 0,
                    "Attribute": "string",
                    "Status": "string",
                    "Verification": "string",
                    "Description": "string"
                  }
                ],
                "Fields_Medium": [
                  {
                    "FieldType": "Medium",
                    "FieldName": "string",
                    "Label": "string",
                    "Language": "string",
                    "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                    "IsPrimary": true,
                    "Order": 0,
                    "MediaType": "string",
                    "FileName": "string",
                    "Caption": "string",
                    "Description": "string",
                    "License": "string",
                    "Credits": "string"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "Fields_TypedString": [
      {
        "FieldType": "TypedString",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "ValueType": "string",
        "Text": "string",
        "Attribute": "string",
        "Status": "string",
        "Verification": "string",
        "Description": "string"
      }
    ],
    "Fields_Dimension": [
      {
        "FieldType": "Dimension",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "DimensionType": "string",
        "Text": "string",
        "Prefix": "string",
        "Suffix": "string",
        "Dimension1": 0.1,
        "Dimension2": 0.1,
        "Dimension3": 0.1,
        "Measure": "string",
        "Description": "string"
      }
    ],
    "Fields_Dating": [
      {
        "FieldType": "Dating",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "DatingType": "string",
        "Text": "string",
        "YearFrom": 0,
        "MonthFrom": 0,
        "DayFrom": 0,
        "YearTo": 0,
        "MonthTo": 0,
        "DayTo": 0,
        "Attribute": "string",
        "Status": "string",
        "Verification": "string",
        "Description": "string"
      }
    ],
    "Fields_Medium": [
      {
        "FieldType": "Medium",
        "FieldName": "string",
        "Label": "string",
        "Language": "string",
        "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "IsPrimary": true,
        "Order": 0,
        "MediaType": "string",
        "FileName": "string",
        "Caption": "string",
        "Description": "string",
        "License": "string",
        "Credits": "string"
      }
    ],
    "Lists": [
      {
        "ListName": "string",
        "ListKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "Language": "string",
        "Label": "string",
        "Items": [
          {
            "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "IsPrimary": true,
            "Order": 0,
            "Language": "string",
            "Fields_Text": [
              {
                "FieldType": "Text",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Value": "string"
              }
            ],
            "Fields_Integer": [
              {
                "FieldType": "Integer",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Value": 0
              }
            ],
            "Fields_Float": [
              {
                "FieldType": "Float",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Value": 0.1
              }
            ],
            "Fields_DateTime": [
              {
                "FieldType": "DateTime",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Value": "2025-12-03T10:39:05.151Z"
              }
            ],
            "Fields_Boolean": [
              {
                "FieldType": "Boolean",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "Value": true
              }
            ],
            "Fields_Reference": [
              "string"
            ],
            "Fields_TypedString": [
              {
                "FieldType": "TypedString",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "ValueType": "string",
                "Text": "string",
                "Attribute": "string",
                "Status": "string",
                "Verification": "string",
                "Description": "string"
              }
            ],
            "Fields_Dimension": [
              {
                "FieldType": "Dimension",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "DimensionType": "string",
                "Text": "string",
                "Prefix": "string",
                "Suffix": "string",
                "Dimension1": 0.1,
                "Dimension2": 0.1,
                "Dimension3": 0.1,
                "Measure": "string",
                "Description": "string"
              }
            ],
            "Fields_Dating": [
              {
                "FieldType": "Dating",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "DatingType": "string",
                "Text": "string",
                "YearFrom": 0,
                "MonthFrom": 0,
                "DayFrom": 0,
                "YearTo": 0,
                "MonthTo": 0,
                "DayTo": 0,
                "Attribute": "string",
                "Status": "string",
                "Verification": "string",
                "Description": "string"
              }
            ],
            "Fields_Medium": [
              {
                "FieldType": "Medium",
                "FieldName": "string",
                "Label": "string",
                "Language": "string",
                "Key": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "IsPrimary": true,
                "Order": 0,
                "MediaType": "string",
                "FileName": "string",
                "Caption": "string",
                "Description": "string",
                "License": "string",
                "Credits": "string"
              }
            ]
          }
        ]
      }
    ]
  }
]