Generate resources

POST 
/resources/generate

Generate resources

Request

Header Parameters

x-accencio-key stringrequired

Product key

application/json

Body

required

Generate resources

config

object

required

resources

object[]

required

Resource identifiers

Array [

key stringrequired

Resource property

Example: ORG_ANALYSIS_KEY

value stringrequired

Resource property value

Example: 1985820c-9ed9-4053-8582-0c9ed9205347

]

output

object

required

Visualization output

visualizer objectrequired

Visualizer type

Example: SPOTFIRE

transformer objectrequired

Visualizer transformer

Example: IPG

format objectrequired

Visualizer output format

Example: URI

version stringrequired

Api version

Example: 1.0

Responses

200

Resource generated successfully

application/json

Schema

Schema

api

object

required

version stringrequired

Api version

Example: 1.0

data

object

required

errors

object[]

required

Errors collection

Array [

type stringrequired

Error type

Example: id: e0d6e244-38e2-4760-96e2-4438e277607c

title stringrequired

Error title

Example: Resource Generation Error

detail stringrequired

Error detail

Example: Resource is not accessible

data

object[]

required

Error data

Array [

id stringrequired

Error id

Example: ccc87b2c-27fc-4c09-9ec0-4faf1c98d3cb

value stringrequired

Error value

Example: 0190fedd-1049-7c5c-cb7c-0ef76f624296

issue stringrequired

Error issue

Example: INVALID - RESOURCE INACCESSIBLE

result stringrequired

Error result

Example: KEY NOT ISSUED

]

]

assets

object[]

required

Requested assets

Array [

format objectrequired

Asset format

Example: URI

transformer objectrequired

Asset transformer

Example: IPG

visualizer objectrequired

Asset visualizer

Example: SPOTFIRE

result objectrequired

Asset value

Example: https://lighthouse.accencio.com/visualization/spotfire?requestKey=cf60ad1d-1176-4e97-a0ad-1d11762e9766&instanceToken=YmEzZTRjN2YtOWFmOC00MzhhLWJlNGMtN2Y5YWY4MzM4YThl

]

Example (from schema)

{
  "api": {
    "version": "1.0"
  },
  "data": {
    "errors": [
      {
        "type": "id: e0d6e244-38e2-4760-96e2-4438e277607c",
        "title": "Resource Generation Error",
        "detail": "Resource is not accessible",
        "data": [
          {
            "id": "84c502a7-53f4-46db-8502-a753f426db28",
            "value": "e0d6e244-38e2-4760-96e2-4438e277607c",
            "issue": "INVALID - RESOURCE INACCESSIBLE",
            "result": "KEY NOT ISSUED"
          }
        ]
      }
    ],
    "assets": [
      {
        "format": "URI",
        "transformer": "IPG",
        "visualizer": "SPOTFIRE",
        "result": "https://lighthouse.accencio.com/visualization/spotfire?requestKey=cf60ad1d-1176-4e97-a0ad-1d11762e9766&instanceToken=YmEzZTRjN2YtOWFmOC00MzhhLWJlNGMtN2Y5YWY4MzM4YThl"
      }
    ]
  }
}

Example

{
  "api": {
    "version": "1.0"
  },
  "data": {
    "errors": [],
    "assets": [
      {
        "format": "URI",
        "transformer": "IPG",
        "visualizer": "SPOTFIRE",
        "result": "https://lighthouse.accencio.com/visualization/spotfire?requestKey=cf60ad1d-1176-4e97-a0ad-1d11762e9766&instanceToken=YmEzZTRjN2YtOWFmOC00MzhhLWJlNGMtN2Y5YWY4MzM4YThl"
      }
    ]
  }
}

201

Resource Generation Error

application/json

Schema

Schema

api

object

required

version stringrequired

Api version

Example: 1.0

data

object

required

errors

object[]

required

Errors collection

Array [

type stringrequired

Error type

Example: id: e0d6e244-38e2-4760-96e2-4438e277607c

title stringrequired

Error title

Example: Resource Generation Error

detail stringrequired

Error detail

Example: Resource is not accessible

data

object[]

required

Error data

Array [

id stringrequired

Error id

Example: ccc87b2c-27fc-4c09-9ec0-4faf1c98d3cb

value stringrequired

Error value

Example: 0190fedd-1049-7c5c-cb7c-0ef76f624296

issue stringrequired

Error issue

Example: INVALID - RESOURCE INACCESSIBLE

result stringrequired

Error result

Example: KEY NOT ISSUED

]

]

assets

object[]

required

Requested assets

Array [

format objectrequired

Asset format

Example: URI

transformer objectrequired

Asset transformer

Example: IPG

visualizer objectrequired

Asset visualizer

Example: SPOTFIRE

result objectrequired

Asset value

Example: https://lighthouse.accencio.com/visualization/spotfire?requestKey=cf60ad1d-1176-4e97-a0ad-1d11762e9766&instanceToken=YmEzZTRjN2YtOWFmOC00MzhhLWJlNGMtN2Y5YWY4MzM4YThl

]

Example (from schema)

{
  "api": {
    "version": "1.0"
  },
  "data": {
    "errors": [
      {
        "type": "id: e0d6e244-38e2-4760-96e2-4438e277607c",
        "title": "Resource Generation Error",
        "detail": "Resource is not accessible",
        "data": [
          {
            "id": "84c502a7-53f4-46db-8502-a753f426db28",
            "value": "e0d6e244-38e2-4760-96e2-4438e277607c",
            "issue": "INVALID - RESOURCE INACCESSIBLE",
            "result": "KEY NOT ISSUED"
          }
        ]
      }
    ],
    "assets": [
      {
        "format": "URI",
        "transformer": "IPG",
        "visualizer": "SPOTFIRE",
        "result": "https://lighthouse.accencio.com/visualization/spotfire?requestKey=cf60ad1d-1176-4e97-a0ad-1d11762e9766&instanceToken=YmEzZTRjN2YtOWFmOC00MzhhLWJlNGMtN2Y5YWY4MzM4YThl"
      }
    ]
  }
}

Example

{
  "api": {
    "version": "1.0"
  },
  "data": {
    "errors": [
      {
        "type": "id: 0190fedd-1049-7c5c-cb7c-0ef76f624296",
        "title": "Resource Generation Error",
        "detail": "Resource is not accessible",
        "data": [
          {
            "id": "ccc87b2c-27fc-4c09-9ec0-4faf1c98d3cb",
            "value": "0190fedd-1049-7c5c-cb7c-0ef76f624296",
            "issue": "INVALID - RESOURCE INACCESSIBLE",
            "result": "KEY NOT ISSUED"
          }
        ]
      }
    ],
    "assets": []
  }
}