Virtual Staging Environment Service API

API Endpoint

Terminology

Utility Endpoints

In addition to the API, the following utility endpoints are available:

  • /health - Health-check page.

  • /health/fault - Purposefully generate a fault page (for diagnostics).

  • Home - Page showing the API name.

Virtual Staging Environments

Virtual Staging Environments

POST /staging/environment
RequestsCreate a staging environment
Headers
Content-Type: application/vnd.api+json
Authorization: [MyAuthToken]
Body
{
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "environments",
        "attributes": {
            "label": "label",
            "enabled": true,
            "rules": [
                "rule_type": "bucket_content",
                "bucket_id": "00000000-0000-0000-0000-000000000000",
                "schemas": [
                    "00000000-0000-0000-0000-000000000000",
                    "00000000-0000-0000-0000-000000000000",
                    "00000000-0000-0000-0000-000000000000"
                ],
                "rule_type": "published_content",
                "tag": "company"
            ]
        },
        "relationships": {
            "security_groups": {
                "data": [
                {
                    "id": "0aa1b9d8-c0c3-4fa5-a38c-69d31baf1530",
                    "type": "{ACCESS}/security_groups"
                } ]
            }
        }
    }
}
Responses200400401403500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Create a virtual staging environment
POST/staging/environment

Create a virtual staging environment.

Requires permission STAGING:FUNCTIONAL:VSE:CREATE

PUT /staging/environment
RequestsUpdate a staging environment
Headers
Content-Type: application/vnd.api+json
Authorization: [MyAuthToken]
Body
{
    "data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "environments",
        "attributes": {
            "label": "label",
            "enabled": true,
            "rules": [
                "rule_type": "bucket_content",
                "bucket_id": "00000000-0000-0000-0000-000000000000",
                "schemas": [
                    "00000000-0000-0000-0000-000000000000",
                    "00000000-0000-0000-0000-000000000000",
                    "00000000-0000-0000-0000-000000000000"
                ],
                "rule_type": "published_content",
                "tag": "company"
            ]
        },
        "relationships": {
            "security_groups": {
                "data": [
                {
                    "id": "0aa1b9d8-c0c3-4fa5-a38c-69d31baf1530",
                    "type": "{ACCESS}/security_groups"
                } ]
            }
        }
    }
}
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Update a virtual staging environment
PUT/staging/environment

Update a virtual staging environment.

Requires permission STAGING:FUNCTIONAL:VSE:EDIT

Virtual Staging Environments

GET /staging/environment
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get all virtual staging environments
GET/staging/environment

Get all virtual staging environments.

Requires permission STAGING:FUNCTIONAL:VSE:READ

Virtual Staging Environments

GET /staging/environment/uuid
Responses200400401403404500
Headers
Content-Type: application/vnd.api+json
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Get virtual staging environment by id
GET/staging/environment/{id}

Get a virtual staging environment by id.

Requires permission STAGING:FUNCTIONAL:VSE:READ

URI Parameters
HideShow
id
string (required) Example: uuid

virtual staging environment id

Virtual Staging Environments

DELETE /staging/environment/uuid
Responses200400401403404500
This response has no content.
Headers
Content-Type: application/json
Body
{
  "status": 400,
  "errorMessage": "Fault"
}
Headers
Content-Type: application/json
Body
{
  "status": 401,
  "errorMessage": "Not allowed: Authentication failed.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 403,
  "errorMessage": "Not allowed: Forbidden, no permission to access.",
  "developerMessage": "auth_violation"
}
Headers
Content-Type: application/json
Body
{
  "status": 404,
  "errorMessage": "Not found.",
  "developerMessage": "Not found."
}
Headers
Content-Type: application/json
Body
{
  "status": 500,
  "errorMessage": "An error message"
}

Delete a virtual staging environment
DELETE/staging/environment/{id}

Delete a virtual staging environment by id.

Requires permission STAGING:FUNCTIONAL:VSE:DELETE

URI Parameters
HideShow
id
string (required) Example: uuid

virtual staging environment id

Generated on 17 Nov 2016