Enterspeed Logo
Documentation Powered by ReDoc

Enterspeed - Management API documentation (0.0.1)

Download OpenAPI specification:Download

Enterspeed: era@enterspeed.com URL: https://www.enterspeed.com/

Management API documentation for Enterspeed.

Introduction

Tenant Header

All API endpoints that contains /tenant/ requires a tenant id to be set in a header value:

X-Tenant-Id = gid://Tenant/386e4a1c-e684-458c-b079-94bc4234de6b

Authentication

BearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

source

Everything about sources

Get all sources

Gets and returns all sources

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a source

Authorizations:
BearerAuth
Request Body schema: application/json

Source object that needs to be created

sourceGroupId
required
string

Source group id.

Only used if tenant is migrated to use source groups.

environmentIds
required
Array of strings

Ids of attached environments.

Note: A specific environmentId can only be used once in the same source group.

Only used if tenant is migrated to use source groups.

name
required
string <= 100 characters

Name of the source

type
required
string <= 25 characters

Type of the source.

Standard types:

  • umbraco-cms
  • struct-pim

Or your custom type value.

Responses

Request samples

Content type
application/json
{
  • "sourceGroupId": "string",
  • "environmentIds": [
    ],
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "sourceGuid": "string"
}

Update a source

Authorizations:
BearerAuth
path Parameters
sourceId
required
string

Source id to delete.

Request Body schema: application/json

Source object that needs to be updated

regenerateAccessKey
boolean

Defines if new access key has to be generated for the source.

environmentIds
required
Array of strings

Ids of attached environments.

Note: A specific environmentId can only be used once in the same source group.

Only used if tenant is migrated to use source groups.

name
required
string <= 100 characters

Name of the source

type
required
string <= 25 characters

Type of the source.

Standard types:

  • umbraco-cms
  • struct-pim

Or your custom type value.

Responses

Request samples

Content type
application/json
{
  • "regenerateAccessKey": true,
  • "environmentIds": [
    ],
  • "name": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "sourceGuid": "string"
}

Delete a source

Authorizations:
BearerAuth
path Parameters
sourceId
required
string

Source id to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Query source entities

Queries and returns source entities for source

Authorizations:
BearerAuth
path Parameters
sourceId
required
string

GUID of source

query Parameters
typeTerm
string
term
string

Partial or exact match for origin id or url

type
Array of strings

Exact matches for included source entity types

first
number
last
number
before
string
after
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pageInfo": {
    },
  • "results": [
    ]
}

Delete all source entities

Deletes all source entities for specific source

Authorizations:
BearerAuth
path Parameters
sourceId
required
string

GUID of source

Responses

Response samples

Content type
application/json
[
  • {
    }
]

environment

Everything about environments

Get all environments

Gets and returns all environments

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an environment

Authorizations:
BearerAuth
Request Body schema: application/json

Environment object that needs to be updated

name
required
string <= 100 characters

Name of the environment

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "environmentGuid": "string"
}

Update an environment

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id to delete

Request Body schema: application/json

Environment object that needs to be updated

name
required
string <= 100 characters

Name of the environment

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "environmentGuid": "string"
}

Delete an environment

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

environment client

Everything about environment clients

Get clients for tenant

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get clients for environment

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id to get clients for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create an environment client

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id to get clients for

Request Body schema: application/json

Environment client object that needs to be created

name
required
string <= 100 characters

Name of the environment client

accessKey
required
string <= 100 characters

Access key of the environment client

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "accessKey": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "environmentGuid": "string",
  • "environmentClientGuid": "string"
}

Update an environment client

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id where client belongs

environmentClientId
required
string

Environment client id to update

Request Body schema: application/json

Environment client object that needs to be updated

name
required
string <= 100 characters

Name of the environment client

regenerateAccessKey
required
boolean

Defines if new access key has to be generated for the environment client.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "regenerateAccessKey": true
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Delete an environment client

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

Environment id where client belongs

environmentClientId
required
string

Environment client id to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

mapping schema

Everything about mapping schemas

Create a release

Authorizations:
BearerAuth
Request Body schema: application/json

Release that needs to be created

environmentId
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "environmentId": "string",
  • "schemas": [
    ]
}

Response samples

Content type
application/json
{
  • "code": "FailedToCreateRelease",
  • "type": null,
  • "title": "One or more errors occured",
  • "status": 400,
  • "detail": "Failed to create a release",
  • "instance": null,
  • "errors": {
    }
}

Get all mapping schemas

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a mapping schema

Authorizations:
BearerAuth
Request Body schema: application/json

Mapping schema object that needs to be created

name
required
string <= 100 characters

Name of the mapping schema

type
string
Enum: "normal" "partial" "collection"
viewHandle
required
string <= 100 characters

View handle of the mapping schema

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "normal",
  • "viewHandle": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "mappingSchemaGuid": "string",
  • "version": 0
}

Update a mapping schema version

Authorizations:
BearerAuth
path Parameters
mappingSchemaId
required
string

Mapping schema id

query Parameters
version
required
integer

Mapping schema version

Request Body schema: application/json

Mapping schema version object that needs to be updated

format
required
string

Format of the mapping schema Supported formats:

  • JSON
schema
object

Schema data.

Responses

Request samples

Content type
application/json
{
  • "format": "string",
  • "schema": { }
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "mappingSchemaGuid": "string",
  • "version": 0
}

Get mapping schema

Authorizations:
BearerAuth
path Parameters
mappingSchemaId
required
string

Mapping schema id

query Parameters
version
integer

Mapping schema version

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "normal",
  • "viewHandle": "string",
  • "id": {
    },
  • "latestVersion": 0,
  • "version": {
    },
  • "versions": [
    ],
  • "deployments": [
    ]
}

Delete a mapping schema

Authorizations:
BearerAuth
path Parameters
mappingSchemaId
required
string

Mapping schema id

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Update a mapping schema

Authorizations:
BearerAuth
path Parameters
mappingSchemaId
required
string

Mapping schema id

Request Body schema: application/json

Mapping schema object that needs to be updated

name
string <= 100 characters

Name of the mapping schema

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "mappingSchemaGuid": "string"
}

Get delivery request

Authorizations:
BearerAuth
Request Body schema: application/json

Defines request context towards Delivery API.

sourceEntityId
required
string

Id of the source entity

format
required
string

Format of the mapping schema Supported formats:

  • JSON
schema
required
object

Schema data

Responses

Request samples

Content type
application/json
{
  • "sourceEntityId": "string",
  • "format": "string",
  • "schema": { }
}

Response samples

Content type
application/json
{
  • "route": {
    },
  • "environmentClients": [
    ]
}

Deploy schema

Authorizations:
BearerAuth
Request Body schema: application/json

Defines deployment of mapping schema

schemaId
required
string

Mapping schema id

comment
string

Optional comment for deployment.

required
Array of objects (InputMappingSchemaEnvironmentDeployment)

Responses

Request samples

Content type
application/json
{
  • "schemaId": "string",
  • "comment": "string",
  • "deployments": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Dry run schema

Authorizations:
BearerAuth
Request Body schema: application/json

Defines dry run operation.

sourceEntityId
required
string

Id of the source entity

viewHandle
required
string

View handle of the mapping schema

format
required
string

Format of the mapping schema Supported formats:

  • JSON
schema
required
object

Schema data

Responses

Request samples

Content type
application/json
{
  • "sourceEntityId": "string",
  • "viewHandle": "string",
  • "format": "string",
  • "schema": { }
}

Response samples

Content type
application/json
{
  • "succeeded": true,
  • "view": {
    },
  • "route": {
    },
  • "errors": [
    ]
}

partial mapping schema

Everything about partial mapping schemas

Get all partial mapping schemas

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a partial mapping schema

Authorizations:
BearerAuth
Request Body schema: application/json

Partial Mapping schema object that needs to be created

name
required
string <= 100 characters

Name of the partial mapping schema

format
required
string <= 100 characters

Format of the partial mapping schema

Supported formats:

  • JSON
data
required
string

Plain text representation for mapping strategy data

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "string",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "mappingSchemaGuid": "string"
}

Get partial mapping schema

Authorizations:
BearerAuth
path Parameters
partialMappingSchemaId
required
string

Partial mapping schema id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "type": "normal",
  • "viewHandle": "string",
  • "id": {
    },
  • "latestVersion": 0,
  • "version": {
    },
  • "versions": [
    ],
  • "deployments": [
    ]
}

Update a partial mapping schema

Authorizations:
BearerAuth
path Parameters
partialMappingSchemaId
required
string

Partial mapping schema id

Request Body schema: application/json

Partial mapping schema object that needs to be updated

name
required
string <= 100 characters

Name of the partial mapping schema

format
required
string <= 100 characters

Format of the partial mapping schema

Supported formats:

  • JSON
data
required
string

Plain text representation for mapping strategy data

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "format": "string",
  • "data": "string"
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Delete a partial mapping schema

Authorizations:
BearerAuth
path Parameters
partialMappingSchemaId
required
string

Partial mapping schema id

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Publish partial schema

Authorizations:
BearerAuth
path Parameters
partialMappingSchemaId
required
string

Id of the partial mapping schema

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

identity

Everything with identity

Authenticate user

Authorizations:
BearerAuth
query Parameters
redirect_uri
string
Request Body schema: application/json

Authentication data

type
required
string

Type to authenticate by - refresh_token or authorization_code

token
string

Code or refresh token

state
string

Additional data to forward to the API

frontendRedirectUrl
string

URL to redirect to after Authentication

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "token": "string",
  • "state": "string",
  • "frontendRedirectUrl": "string"
}

Response samples

Content type
application/json
{}

Signout user

Authorizations:
BearerAuth

Responses

tenant

Everything with tenants

Get tenants by ids

Authorizations:
BearerAuth
query Parameters
ids
Array of strings

Tenant id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a tenant

Authorizations:
BearerAuth
Request Body schema: application/json

Tenant to be created

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Update a tenant

Authorizations:
BearerAuth
Request Body schema: application/json

Tenant to be updated

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Delete a tenant

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

management client

Everything with management clients

Get all management clients

Gets and returns all management clients

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a management client

Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string <= 100 characters

Name of the management client

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "managementClientGuid": "string"
}

Update a management client

Authorizations:
BearerAuth
path Parameters
managementClientGuid
required
string

GUID of management client to update

Request Body schema: application/json

Management client object that needs to be updated

name
required
string <= 100 characters

Name of the management client

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "managementClientGuid": "string"
}

Delete a management client

Authorizations:
BearerAuth
path Parameters
managementClientGuid
required
string

GUID of management client to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

Regenerate access key for a management client

Authorizations:
BearerAuth
path Parameters
managementClientGuid
required
string

GUID of management client to regenerate access key

Responses

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "managementClientGuid": "string"
}

source entities

Reprocess source entities

Authorizations:
BearerAuth
Request Body schema: application/json

Source object that needs to be created

sourceEntityIds
required
Array of strings

Ids of source entities for processing.

Responses

Request samples

Content type
application/json
{
  • "sourceEntityIds": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

source group

Get all source groups

Gets and returns all source groups for tenant

Only available if tenant is migrated to use source groups.

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a source group

Only available if tenant is migrated to use source groups.

Authorizations:
BearerAuth
Request Body schema: application/json

Source group object that needs to be created

name
required
string <= 100 characters

Name of the source group

type
required
string <= 25 characters

Type of the source group.

Standard types:

  • umbraco-cms
  • struct-pim

Or your custom type value.XXX

alias
string

Alias of the source group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "alias": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "sourceGroupGuid": "string"
}

Update a source group

Only available if tenant is migrated to use source groups.

Authorizations:
BearerAuth
path Parameters
sourceGroupId
required
string

Source group id to delete.

Request Body schema: application/json

Source group object that needs to be updated

name
required
string <= 100 characters

Name of the source group

type
required
string <= 25 characters

Type of the source group.

Standard types:

  • umbraco-cms
  • struct-pim

Or your custom type value.XXX

alias
string

Alias of the source group

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "alias": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "sourceGroupGuid": "string"
}

Delete a source group

Authorizations:
BearerAuth
path Parameters
sourceGroupId
required
string

Source group id to delete

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}

user

Query paged users for tenant

Authorizations:
BearerAuth
query Parameters
term
string

Partial or exact match for users email, firstname, lastname.

first
number
last
number
before
string
after
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pageInfo": {
    },
  • "results": [
    ]
}

Update user roles for tenant

Updates existing user roles for tenant

Authorizations:
BearerAuth
path Parameters
userGuid
required
string

User guid to update

Request Body schema: application/json
tenantRoles
Array of strings

List of tenant roles for user.

Responses

Request samples

Content type
application/json
{
  • "tenantRoles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "identityId": "string",
  • "identityIssuer": "string",
  • "emails": [
    ],
  • "roles": [
    ],
  • "tenants": {
    }
}

Add user to tenant

Add existing user to tenant

Authorizations:
BearerAuth
Request Body schema: application/json
email
required
string

Email of user to add

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": {
    },
  • "firstName": "string",
  • "lastName": "string",
  • "identityId": "string",
  • "identityIssuer": "string",
  • "emails": [
    ],
  • "roles": [
    ],
  • "tenants": {
    }
}

invite

Create invite

Authorizations:
BearerAuth
Request Body schema: application/json

Invite object that has to be created

inviteeEmail
required
string

Email of invitee

message
string

Optional invitation text (visible to invitee).

Responses

Request samples

Content type
application/json
{
  • "inviteeEmail": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Get invite by id

Authorizations:
BearerAuth
path Parameters
inviteGuid
required
string

Invite guid to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "invitee": {
    },
  • "inviter": {
    },
  • "tenant": {
    },
  • "message": "string",
  • "tenantRoles": [
    ],
  • "state": "Pending",
  • "createdAt": "string",
  • "expiresAt": "string",
  • "acceptedAt": "string",
  • "declinedAt": "string",
  • "cancelledAt": "string"
}

Query paged invites for tenant

Authorizations:
BearerAuth
query Parameters
inviteeEmailTerm
string

Partial or exact match for invitee email

state
string (InviteState)
Enum: "Pending" "Accepted" "Declined" "Expired" "Cancelled"

State for invite

first
number
last
number
before
string
after
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pageInfo": {
    },
  • "results": [
    ]
}

Get pending invites for current user

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resend invite

If you want to resend invite email as tenant or Enterspeed admin.

Authorizations:
BearerAuth
path Parameters
inviteGuid
required
string

Invite guid to resend

Responses

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Cancel invite

If you want to cancel invite as tenant or Enterspeed admin.

Authorizations:
BearerAuth
path Parameters
inviteGuid
required
string

Invite guid to cancel

Responses

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Accept invite

If you want to accept the invite as invitee.

Authorizations:
BearerAuth
path Parameters
inviteGuid
required
string

Invite guid to accept

Responses

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Decline invite

If you want to decline the invite as invitee.

Authorizations:
BearerAuth
path Parameters
inviteGuid
required
string

Invite guid to decline

Responses

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

views

Query environment views

Queries and returns views for environment

Authorizations:
BearerAuth
path Parameters
environmentId
required
string

GUID of environment

query Parameters
sourceGuid
string

GUID of source

sourceEntityOriginId
string

Origin id of source entity

schemaAlias
string

Alias of mapping schema

first
number
last
number
before
string
after
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pageInfo": {
    },
  • "results": [
    ]
}

Get view by id

Gets and returns view by id

Authorizations:
BearerAuth
query Parameters
id
required
string

GID of view

Responses

Response samples

Content type
application/json
{
  • "id": {
    },
  • "referencedIds": [
    ],
  • "routeIds": [
    ],
  • "properties": { },
  • "updatedAt": "string"
}

routes

Get delivery request context for route.

Authorizations:
BearerAuth
Request Body schema: application/json

Defines request context towards Delivery API.

routeId
required
string

Route id.

Responses

Request samples

Content type
application/json
{
  • "routeId": "string"
}

Response samples

Content type
application/json
{
  • "url": "string",
  • "handle": "string",
  • "environmentClients": [
    ]
}

admin

Query tenants

Queries and returns tenants accessable for Enterspeed admin

Authorizations:
BearerAuth
query Parameters
term
string

Partial or exact match for tenant name

first
number
last
number
before
string
after
string

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "pageInfo": {
    },
  • "results": [
    ]
}

Create a tenant

Authorizations:
BearerAuth
Request Body schema: application/json

Tenant to be created

name
required
string
maxProcessingTimeInSeconds
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "maxProcessingTimeInSeconds": 0
}

Response samples

Content type
application/json
{
  • "idValue": "string",
  • "tenantGuid": "string"
}

Update a tenant

Authorizations:
BearerAuth
Request Body schema: application/json

Tenant to be updated

name
required
string
maxProcessingTimeInSeconds
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "maxProcessingTimeInSeconds": 0
}

Response samples

Content type
application/json
{
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "extensions": {
    },
  • "type": "string"
}