Fuentes

Referencia de la API para enumerar y gestionar fuentes en Communications Mining en Automation Cloud.

Obtener todas las fuentes

/api/v1/sources

Permisos necesarios: ver orígenes

Bash

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

Nodo

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))

Respuesta

{
  "sources": [
    {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
      "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"
}

Obtener fuentes por proyecto

/api/v1/sources/<project>

Permisos necesarios: ver orígenes

Bash

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

Nodo

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))

Respuesta

{
  "sources": [
    {
      "created_at": "2016-02-10T23:13:28.340295+00:00",
      "description": "An optional long form description.",
      "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
      "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"
}

Obtener una fuente por proyecto y nombre

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

Permisos necesarios: ver orígenes

Bash

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

Nodo

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))

Respuesta

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
    "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"
}

Obtener una fuente por ID

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

Permisos necesarios: ver orígenes

Bash

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

Nodo

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))

Respuesta

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
    "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"
}

Crear una fuente

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

Permisos necesarios: administrador de fuentes

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"
  }
}'

Nodo

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))

Respuesta

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An optional long form description.",
    "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
    "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"
}

Nombre	Tipo	Obligatorio	Descripción
language	String	No	El idioma principal del origen. Los valores admitidos son en (inglés) y Multilingüe. El valor predeterminado es en.
title	String	No	Título legible por humanos de una línea para la fuente.
description	String	No	Una descripción más larga de la fuente.
should_translate	Booleano	No	Si los mensajes cargados en este origen deben traducirse al idioma cuando sea necesario. El valor predeterminado es falso.
sensitive_properties	array<string>	No	Una matriz de propiedades que deben marcarse como confidenciales y ocultarse a los usuarios sin privilegios.
bucket_id	String	No	ID de un depósito desde el que cargar datos. Los datos se analizarán en comentarios y se cargarán en esta fuente.
email_transform_tag	String	No	The transform tag that controls how raw emails uploaded to this source are parsed. Defaults to a tag selected for your organization.

Actualizar una fuente

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

Permisos necesarios: administrador de fuentes

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."
  }
}'

Nodo

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))

Respuesta

{
  "source": {
    "created_at": "2016-02-10T23:13:28.340295+00:00",
    "description": "An alternative description.",
    "email_transform_tag": "generic_simple_markup_set_id.0.3LPWBXWR",
    "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"
}

All of the following fields are optional. A request updates only the fields present in the source object and leaves the rest of the source unchanged. The preceding example changes description only.

Nombre	Tipo	Obligatorio	Descripción
title	String	No	Título legible por humanos de una línea para la fuente.
description	String	No	Una descripción más larga de la fuente.
should_translate	Booleano	No	Si los mensajes cargados en esta fuente deben traducirse al inglés cuando sea necesario. El valor predeterminado es falso.
sensitive_properties	array<string>	No	Una matriz de propiedades que deben marcarse como confidenciales y ocultarse a los usuarios sin privilegios.
bucket_id	String	No	ID de un depósito desde el que cargar datos. Los datos se analizarán en comentarios y se cargarán en esta fuente.
email_transform_tag	String	No	The transform tag that controls how raw emails in this source are parsed. Changing it re-parses the messages already in the source, and is rejected with a 422 response if the tag is not recognized.

Eliminar una fuente

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

Permisos necesarios: administrador de fuentes

Bash

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

Nodo

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))

Respuesta

{
  "status": "ok"
}