Page Comparison

...

{
  "Config": {
    "CustomPropertyA" : "example"
  },
  "Metadata": {
    "Descriptive": {
        "Title": "My object",
        ...
    }
  }
}

GET insights

...

Returns the list of available insights on the object without returning the detail of each insight.

Input

The input uses the following HTTP parameters

...

• 200 OK with the response

• 409 Conflict when the analysis is still pending

• The output is a JSON array of JSON objects with the following properties

Example

{
  "Insights": [
    {
      "Name": "Summary",
      "Id": "SUMMARY",
      "Value": "SUMMARIESThis is the summary of your document..."
   },
   {
      "Name": "Word cloudEntitiesOrganisations",
      "Id": "WORD_CLOUD"ENTITIES_ORG",
      "Value": ["The European Parliament", "Zeticon", ...]
   }
]

GET insights/{ID}

Returns the details of a particular insight including the raw data.

Input

• The insight ID is specified as a path variable.

• The input uses the following HTTP parameters

...

Parameter

...

Description

...

recordId

...

The record ID of the object in question

...

<mapping>

...

The custom properties configured on the plugin are passed as a sequence of parameters → https://mediahaven.atlassian.net/wiki/spaces/CS/pages/4438884395/Module+Plugins#Custom-properties

Response / Output

• 200 OK with the response

• 409 Conflict when the analysis is still pending

• The output is a JSON object with the following properties

...

Property

...

Type

...

Description

...

Name

...

String

...

The name of the insight

...

Id

...

String

...

The ID of the insight such that it can be requested indivudually.

...

Data

...

String

...

The data of this particular insight

Example

{
  "Name": "Word cloud",
  "Id": "WORD_CLOUD",
  "Data": "<your data>",
   {
      "Name": "EntitiesLocations",
      "Id": "ENTITIES_LOC",
      "Value": ["Gent", "Antwerp", ...]
   },
   {
      "Name": "EntitiesPerson",
      "Id": "ENTITIES_PERSON",
      "Value": ["Alice", "Bob", ...]
   },
   {
      "Name": "EntitiesGeneral",
      "Id": "ENTITIES_MISC",
      "Value": ["Document", "Paper", ...]
   },
    {
    "Name": "Actions",
    "Id": "ACTIONS",
    "Value": ["voorstellen", "afwerken", ...]
   }
  ],
  "RawData": <RAW DATA>
}