Quellen

Alle Quellen abrufen

/api/v1/sources

Erforderliche Berechtigungen: Quellen anzeigen

Bash

curl -X GET 'https://<my_api_endpoint>/api/v1/sources' \
    -H "Authorization: Bearer $REINFER_TOKEN"

Knoten

const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/sources",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/sources",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "sources": [
    {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "id": "18ba5ce699f8da1f",
      "last_modified": "2016-02-10T23:13:28.340295+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-10T23:13:28.340295+00:00"
    }
  ],
  "status": "ok"
}

Rufen Sie Quellen nach Projekt ab

/api/v1/sources/<project>

Erforderliche Berechtigungen: Quellen anzeigen

Bash

curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>' \
    -H "Authorization: Bearer $REINFER_TOKEN"

Knoten

const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/<project>",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/sources/<project>",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "sources": [
    {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "id": "18ba5ce699f8da1f",
      "last_modified": "2016-02-10T23:13:28.340295+00:00",
      "name": "example",
      "owner": "<project>",
      "sensitive_properties": [],
      "should_translate": false,
      "title": "An Example Source",
      "updated_at": "2016-02-10T23:13:28.340295+00:00"
    }
  ],
  "status": "ok"
}

Rufen Sie eine Quelle nach Projekt und Name ab

/api/v1/sources/<project>/<source_name>

Erforderliche Berechtigungen: Quellen anzeigen

Bash

curl -X GET 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
    -H "Authorization: Bearer $REINFER_TOKEN"

Knoten

const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "id": "18ba5ce699f8da1f",
    "last_modified": "2016-02-10T23:13:28.340295+00:00",
    "name": "example",
    "owner": "<project>",
    "sensitive_properties": [],
    "should_translate": false,
    "title": "An Example Source",
    "updated_at": "2016-02-10T23:13:28.340295+00:00"
  },
  "status": "ok"
}

Rufen Sie eine Quelle nach ID ab

/api/v1/sources/id:<source_id>

Erforderliche Berechtigungen: Quellen anzeigen

Bash

curl -X GET 'https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f' \
    -H "Authorization: Bearer $REINFER_TOKEN"

Knoten

const request = require("request");

request.get(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.get(
    "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "id": "18ba5ce699f8da1f",
    "language": "en",
    "last_modified": "2016-02-10T23:13:28.340295+00:00",
    "name": "example",
    "owner": "<project>",
    "sensitive_properties": [],
    "should_translate": false,
    "title": "An Example Source",
    "updated_at": "2016-02-10T23:13:28.340295+00:00"
  },
  "status": "ok"
}

Erstellen Sie eine Quelle

/api/v1/sources/<project>/<source_name>

Erforderliche Berechtigungen: Quellenadministrator

Bash

curl -X PUT 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "source": {
    "description": "An optional long form description.",
    "title": "An Example Source"
  }
}'

Knoten

const request = require("request");

request.put(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: {
      source: {
        description: "An optional long form description.",
        title: "An Example Source",
      },
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.put(
    "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={
        "source": {
            "title": "An Example Source",
            "description": "An optional long form description.",
        }
    },
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "id": "18ba5ce699f8da1f",
    "language": "en",
    "last_modified": "2016-02-10T23:13:28.340295+00:00",
    "name": "example",
    "owner": "<project>",
    "sensitive_properties": [],
    "should_translate": false,
    "title": "An Example Source",
    "updated_at": "2016-02-10T23:13:28.340295+00:00"
  },
  "status": "ok"
}

Name	Typ	Erforderlich	Beschreibung
language	string	nein	Die primäre Sprache der Quelle. Unterstützte Werte sind en (englisch) und mehrsprachig. Die Standardeinstellung ist en.
title	string	nein	Einzeiliger, visuell lesbarer Titel für die Quelle.
description	string	nein	Eine längere Beschreibung der Quelle.
should_translate	boolean	nein	Ob Nachrichten, die in diese Quelle hochgeladen werden, in die erforderliche Sprache übersetzt werden sollen. Der Standardwert ist „false“.
sensitive_properties	array<string>	nein	Ein Array von Eigenschaften, die als vertraulich markiert und für nicht privilegierte Benutzer ausgeblendet werden sollen.
bucket_id	string	nein	ID eines Buckets, aus dem Daten geladen werden sollen. Daten werden in Kommentare geparst und in diese Quelle geladen.

Aktualisieren Sie eine Quelle

/api/v1/sources/<project>/<source_name>

Erforderliche Berechtigungen: Quellenadministrator

Bash

curl -X POST 'https://<my_api_endpoint>/api/v1/sources/<project>/example' \
    -H "Authorization: Bearer $REINFER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
  "source": {
    "description": "An alternative description."
  }
}'

Knoten

const request = require("request");

request.post(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
    json: true,
    body: { source: { description: "An alternative description." } },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.post(
    "https://<my_api_endpoint>/api/v1/sources/<project>/example",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
    json={"source": {"description": "An alternative description."}},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An alternative description.",
    "id": "18ba5ce699f8da1f",
    "language": "en",
    "last_modified": "2016-02-11T08:06:14.944290+00:00",
    "name": "example",
    "owner": "<project>",
    "sensitive_properties": [],
    "should_translate": false,
    "title": "An Example Source",
    "updated_at": "2016-02-11T08:06:14.944290+00:00"
  },
  "status": "ok"
}

Name	Typ	Erforderlich	Beschreibung
title	string	nein	Einzeiliger, visuell lesbarer Titel für die Quelle.
description	string	nein	Eine längere Beschreibung der Quelle.
should_translate	boolean	nein	Ob Nachrichten, die in diese Quelle hochgeladen werden, ggf. ins Englische übersetzt werden sollen. Der Standardwert ist „false“.
sensitive_properties	array<string>	nein	Ein Array von Eigenschaften, die als vertraulich markiert und für nicht privilegierte Benutzer ausgeblendet werden sollen.
bucket_id	string	nein	ID eines Buckets, aus dem Daten geladen werden sollen. Daten werden in Kommentare geparst und in diese Quelle geladen.

Löschen Sie eine Quelle

/api/v1/sources/id:<source_id>

Erforderliche Berechtigungen: Quellenadministrator

Bash

curl -X DELETE 'https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f' \
    -H "Authorization: Bearer $REINFER_TOKEN"

Knoten

const request = require("request");

request.delete(
  {
    url: "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
    headers: {
      Authorization: "Bearer " + process.env.REINFER_TOKEN,
    },
  },
  function (error, response, json) {
    // digest response
    console.log(JSON.stringify(json, null, 2));
  }
);

Python

import json
import os

import requests

response = requests.delete(
    "https://<my_api_endpoint>/api/v1/sources/id:18ba5ce699f8da1f",
    headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
)

print(json.dumps(response.json(), indent=2, sort_keys=True))

Antwort

{
  "status": "ok"
}