REST API for Unified Assurance Vision

Add a JSON Data Resource for a Custom Layer

post

/vision/api/rawJson/{name}

Adds a JSON data resource to the specified custom layer.
Unified Assurance roles with the following Vision package permissions have access to this endpoint:

Admin
Api

Request

Path Parameters

name(required): string
The name of the layer to add JSON data to.
Example:
```
customLayer
```

Supported Media Types

Root Schema : schema

Type: string

Response

Supported Media Types

application/json

200 Response

Root Schema : SuccessResponse

Type: object

The success response details.

Show Source

csrfToken: string

The security token to prevent cross-site request forgery (CSRF).

Example: 12345
message: string

The response message.

Example: The entities were added successfully.
reason: string

The reason phrase for the response.

Example: OK
status: integer (int32)

The response status code.

Example: 200

{
    "properties":{
        "csrfToken":{
            "description":"The security token to prevent cross-site request forgery (CSRF).",
            "example":"12345",
            "type":"string"
        },
        "message":{
            "description":"The response message.",
            "example":"The entities were added successfully.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"OK",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":200,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The success response details.",
    "type":"object"
}

401 Response

Unauthorized Access

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

404 Response

Resource not Found

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

422 Response

Unprocessable Entity. Usually due to not providing a required field.

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}

500 Response

The server encountered an unexpected condition that prevented it from fulfilling the request.

Root Schema : schema

Type: object

The error response details.

Show Source

message: string

The error message.

Example: An internal server error occurred.
reason: string

The reason phrase for the response.

Example: INTERNAL SERVER ERROR
status: integer (int32)

The response status code.

Example: 500

{
    "properties":{
        "message":{
            "description":"The error message.",
            "example":"An internal server error occurred.",
            "type":"string"
        },
        "reason":{
            "description":"The reason phrase for the response.",
            "example":"INTERNAL SERVER ERROR",
            "type":"string"
        },
        "status":{
            "description":"The response status code.",
            "example":500,
            "format":"int32",
            "type":"integer"
        }
    },
    "description":"The error response details.",
    "type":"object"
}