Application

A Data Store

Overview
Parent
Objects
Properties
Methods
Examples
Schema

An Application is a Data Store where you can store configuration related to your mobile, touch or web application.

An Application Data Store provides services and objects that are you may choose to use to provide functionality and manage state for your application. This includes:

User Registration
Sign Up, Confirmation Emails
Email Services
Settings and Configuration storage
Page Layout and Module assignment

Note	Drop in one of our language drivers to accelerate your development. Here are links to some of our popular Cookbooks to help you get started! C# Go Java JavaScript PHP Python Ruby

Parent

This Application is contained within a Platform.

Objects

This Application contains the following objects:

Properties

The following properties are available:

Property	Type	Default	Read-Only	Description
_doc	string		No	The primary ID
_system	object		No	Metadata maintained by the system
applicationType	string		No	The type of application
binaryStorageProviderType	string		No	The type identifier for the binary storage provider that backs this data store
datastoreId	string		Yes	The ID of the data store
datastoreTypeId	string		Yes	The data store type identifier
deployments	object		No
description	string		No	A description of the data store
enableAuthorities	boolean	true	No	Whether to check access control rights for principals against this data store
key	string		No	Unique key that serves as an identifier for this application
locked	boolean		Yes	Whether the data store is presently locked. If the data store is locked, then write operations against it will block.
lockedBy	string		No	The principal that holds the lock (if the data store is locked)
maxsize	number		No	The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit.
objectcount	number		No	The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read.
public	object		No
size	number		Yes	The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read.
source	object		No
statisticsDate	object		No	Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations.
statisticsDirty	boolean		Yes	Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity.
title	string		No	The title of the data store
trustedHost	string		No	The host for a trusted application
trustedScope	string		No	The scope identifier for a trusted application

Methods

The following methods are available:

Add Team Member
Applicationtypes
Check Membership
Check Permission
Check Single Authority
Check multiple Authorities
Check multiple Permissions
Create Application
Create Application
Create a Team
Creates a role for an application
Delete Application
Delete Application
Deletes a Team
Deletes a role for an application
Deletes a role for an application
Deploys an application
Gathers statistics for an application
Get Team
Grant Authority
Grant Authority to Team
List Team Authorities
List Teams
Lists Application
Lists Application
Lists Team Members
Lists the roles for an application
Locks an application
Looks up a deployed application
Queries for Application
Read ACL
Read ACL for Principal
Read Application
Read Authorities Report
Reads a role for an application
Redeploys a deployed application
Refreshes API keys for a deployment
Remove Team Member
Retrieved deployment info for a deployed application
Retrieves the API Keys information for all deployments of an application
Retrieves the API Keys information for an application deployment
Revoke Authority
Revoke Authority from Team
Starts an export job for this resource
Starts an import job for this resource
Undeploys a deployed application
Unlocks an application
Update Application
Update Application
Update a Team
Updates a role for an application
Updates a role for an application

Add Team Member

Adds a principal to a team for an application

POST /applications/{applicationId}/teams/{teamKey}/members/add

Parameters

Name	Required	Type
applicationId	true	string
teamKey	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Applicationtypes

GET /applicationtypes

Parameters

This function has no parameters.

Response

{}

Check Membership

Checks whether a principal belongs to a team for an application

POST /applications/{applicationId}/teams/{teamKey}/members/check

Parameters

Name	Required	Type
applicationId	true	string
teamKey	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Check Permission

Checks whether an actor has a permission over an application

POST /applications/{applicationId}/permissions/{permissionId}/check

Parameters

Name	Required	Type
applicationId	true	string
permissionId	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check Single Authority

Checks whether a single authority is granted against the specified application for the given user

POST /applications/{applicationId}/authorities/{authorityId}/check

Parameters

Name	Required	Type
applicationId	true	string
authorityId	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}

Check multiple Authorities

Checks whether one or more authorities against the specified application are granted for a given set of users

POST /applications/authorities/check

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Check multiple Permissions

Checks whether multiple actors have permissions over an application

POST /applications/permissions/check

Parameters

Name	Required	Type	Description
HTTP Payload	true	string	HTTP Payload

Response

{
  "type": "object",
  "description": "List of Principals to Check",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

Create Application

Creates a new Application

POST /applications

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create Application

Creates a new Application

POST /applications/

Parameters

This function has no parameters.

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Create a Team

Creates a team for an application

POST /applications/{applicationId}/teams

Parameters

Name	Required	Type	Description
applicationId	true	string
key	false	string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Creates a role for an application

POST /applications/{applicationId}/roles

Parameters

Name	Required	Type	Description
applicationId	true	string
HTTP Payload	true	string	HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Application

Deletes an existing Application

DELETE /applications/{applicationId}

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Delete Application

Deletes an existing Application

POST /applications/{applicationId}/delete

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deletes a Team

Deletes a team for an application

DELETE /applications/{applicationId}/teams/{teamKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
teamKey	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deletes a role for an application

POST /applications/{applicationId}/roles/{roleKeyOrId}/delete

Parameters

Name	Required	Type	Description
applicationId	true	string
roleKeyOrId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deletes a role for an application

DELETE /applications/{applicationId}/roles/{roleKeyOrId}

Parameters

Name	Required	Type	Description
applicationId	true	string
roleKeyOrId	true	string
HTTP Payload	true	string	HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Deploys an application

POST /applications/{applicationId}/deploy/{deploymentKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Deployed Application",
  "properties": {
    "applicationId": {
      "type": "string"
    },
    "deploymentKey": {
      "type": "string"
    },
    "deploymentWebhost": {
      "type": "string"
    },
    "host": {
      "type": "string"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Gathers statistics for an application

POST /applications/{applicationId}/stats

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Get Team

Reads a team for this application

GET /applications/{applicationId}/teams/{teamKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
teamKey	true	string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Grant Authority

Grants an authority against the specified application to a given user

POST /applications/{applicationId}/authorities/{authorityId}/grant

Parameters

Name	Required	Type
applicationId	true	string
authorityId	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Grant Authority to Team

Grants an authority to a team for an application

POST /applications/{applicationId}/teams/{teamKey}/authorities/{authorityId}/grant

Parameters

Name	Required	Type
applicationId	true	string
teamKey	true	string
authorityId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

List Team Authorities

Lists the authorities that an team is granted

GET /applications/{applicationId}/teams/{teamKey}/authorities

Parameters

Name	Required	Type	Description
applicationId	true	string
teamKey	true	string

Response

{
  "$ref": "#/components/schemas/authoritieslist"
}

List Teams

Lists all of the teams for an application

GET /applications/{applicationId}/teams

Parameters

Name	Required	Type	Description
applicationId	true	string
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_team"
      }
    }
  }
}

Lists Application

Retrieves a list of Application instances

GET /applications

Parameters

Name	Required	Type	Description
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_application"
      }
    }
  }
}

Lists Application

Retrieves a list of Application instances

GET /applications/

Parameters

Name	Required	Type	Description
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_application"
      }
    }
  }
}

Lists Team Members

Lists the members of a team for this application

GET /applications/{applicationId}/teams/{teamKey}/members

Parameters

Name	Required	Type	Description
applicationId	true	string
teamKey	true	string
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_domainprincipal"
      }
    }
  }
}

Lists the roles for an application

GET /applications/{applicationId}/roles

Parameters

Name	Required	Type	Description
applicationId	true	string
inherited	false	string

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap"
      }
    }
  }
}

Locks an application

POST /applications/{applicationId}/lock

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Looks up a deployed application

GET /applications/{applicationId}/deployed/{deploymentKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "extends": "document",
  "container": "application",
  "description": "Deployed Application",
  "properties": {
    "applicationId": {
      "type": "string"
    },
    "deploymentKey": {
      "type": "string"
    },
    "deploymentWebhost": {
      "type": "string"
    },
    "host": {
      "type": "string"
    },
    "urls": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Queries for Application

Queries for instances of type Application

POST /applications/query

Parameters

Name	Required	Type	Description
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_application"
      }
    }
  }
}

Read ACL

Read the Access Control List for the specified application

GET /applications/{applicationId}/acl/list

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}

Read ACL for Principal

Read the Access Control List for the specified application and the given principal

GET /applications/{applicationId}/acl

Parameters

Name	Required	Type	Description
applicationId	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}

Read Application

Reads an instance of a Application

GET /applications/{applicationId}

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Application",
  "extends": "datastore",
  "container": "platform",
  "properties": {
    "key": {
      "type": "string",
      "description": "Unique key that serves as an identifier for this application"
    },
    "applicationType": {
      "type": "string",
      "enum": [
        "web",
        "trusted"
      ],
      "description": "The type of application"
    },
    "trustedScope": {
      "type": "string",
      "enum": [
        "webdav",
        "ftp",
        "cmis"
      ],
      "description": "The scope identifier for a trusted application"
    },
    "trustedHost": {
      "type": "string",
      "description": "The host for a trusted application"
    },
    "deployments": {
      "type": "object",
      "properties": {
        "webhost": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "clientId": {
          "type": "string"
        },
        "authGrantId": {
          "type": "string"
        },
        "baseURL": {
          "type": "string"
        }
      }
    },
    "source": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "public": {
          "type": "boolean"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "public": {
      "type": "object",
      "properties": {
        "runAsPrincipalId": {
          "type": "string"
        },
        "emailProviderId": {
          "type": "string"
        },
        "userDomainId": {
          "type": "string"
        },
        "tenantRegistrarId": {
          "type": "string"
        }
      }
    },
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  }
}

Read Authorities Report

Read the Authorities Report for the specified application

POST /applications/{applicationId}/authorities

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Reads a role for an application

GET /applications/{applicationId}/roles/{roleKeyOrId}

Parameters

Name	Required	Type
applicationId	true	string
roleKeyOrId	true	string
inherited	false	string

Response

{
  "$ref": "#/components/schemas/"
}

Redeploys a deployed application

POST /applications/{applicationId}/redeploy/{deploymentKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "description": "Status of Operation (with ID)",
  "extends": "status",
  "properties": {
    "_doc": {
      "type": "string"
    },
    "ok": null
  }
}

Refreshes API keys for a deployment

POST /applications/{applicationId}/deployments/{deploymentKey}/refreshkeys

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Remove Team Member

Removes a principal from a team for an application

POST /applications/{applicationId}/teams/{teamKey}/members/remove

Parameters

Name	Required	Type
applicationId	true	string
teamKey	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Retrieved deployment info for a deployed application

GET /applications/{applicationId}/deployed/{deploymentKey}/info

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "description": "Remote deployment info",
  "properties": {}
}

Retrieves the API Keys information for all deployments of an application

GET /applications/{applicationId}/deployments/{deploymentKey}/apikeys

Parameters

Name	Required	Type	Description
applicationId	true	string	The ID of the application
deploymentKey	true	string
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{}

Retrieves the API Keys information for an application deployment

GET /applications/{applicationId}/apikeys

Parameters

Name	Required	Type	Description
applicationId	true	string	The ID of the application
sort	false	object	Defines how to sort fields in the result set
skip	false	number	Skips the result set cursor ahead the specified number of records
limit	false	number	Specifies the number of records to be handed back in the result set

Response

{}

Revoke Authority

Revokes an authority against the specified application from a given user

POST /applications/{applicationId}/authorities/{authorityId}/revoke

Parameters

Name	Required	Type
applicationId	true	string
authorityId	true	string
id	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Revoke Authority from Team

Grants an authority from a team for an application

POST /applications/{applicationId}/teams/{teamKey}/authorities/{authorityId}/revoke

Parameters

Name	Required	Type
applicationId	true	string
teamKey	true	string
authorityId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Starts an export job for this resource

POST /applications/{applicationId}/export

Parameters

Name	Required	Type	Description
applicationId	true	string
groupId	false	string	The Group ID to be assigned to the exported archive
artifactId	false	string	The Artifact ID to be assigned to the exported archive
versionId	false	string	The Version ID to be assigned to the exported archive
vaultId	false	string	The ID of the vault where the exported archive should be saved
schedule	false	string	Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object"
    },
    "endDate": {
      "type": "object"
    },
    "startChangeset": {
      "type": "string"
    },
    "endChangeset": {
      "type": "string"
    },
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}

Starts an import job for this resource

POST /applications/{applicationId}/import

Parameters

Name	Required	Type	Description
applicationId	true	string
groupId	false	string	The Group ID to be assigned to the exported archive
artifactId	false	string	The Artifact ID to be assigned to the exported archive
versionId	false	string	The Version ID to be assigned to the exported archive
vaultId	false	string	The ID of the vault where the exported archive should be saved
schedule	false	string	Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous')

Response

{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean"
    },
    "includeTeams": {
      "type": "boolean"
    },
    "includeActivities": {
      "type": "boolean"
    },
    "includeBinaries": {
      "type": "boolean"
    },
    "includeAttachments": {
      "type": "boolean"
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "substitutions": {
      "type": "string"
    }
  }
}

Undeploys a deployed application

POST /applications/{applicationId}/undeploy/{deploymentKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
deploymentKey	true	string

Response

{
  "type": "object",
  "description": "Status of Operation (with ID)",
  "extends": "status",
  "properties": {
    "_doc": {
      "type": "string"
    },
    "ok": null
  }
}

Unlocks an application

POST /applications/{applicationId}/unlock

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Application

Updates an existing Application

PUT /applications/{applicationId}

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update Application

Updates an existing Application

POST /applications/{applicationId}/update

Parameters

Name	Required	Type	Description
applicationId	true	string

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Update a Team

Updates a team for an application

PUT /applications/{applicationId}/teams/{teamKey}

Parameters

Name	Required	Type	Description
applicationId	true	string
teamKey	true	string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}

Updates a role for an application

PUT /applications/{applicationId}/roles/{roleKeyOrId}

Parameters

Name	Required	Type	Description
applicationId	true	string
roleKeyOrId	true	string
HTTP Payload	true	string	HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Updates a role for an application

POST /applications/{applicationId}/roles/{roleKeyOrId}/update

Parameters

Name	Required	Type	Description
applicationId	true	string
roleKeyOrId	true	string
HTTP Payload	true	string	HTTP Payload

Response

{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}

Schema


{
  "type": "object",
  "description": "Application",
  "extends": "datastore",
  "container": "platform",
  "properties": {
    "key": {
      "type": "string",
      "description": "Unique key that serves as an identifier for this application"
    },
    "applicationType": {
      "type": "string",
      "enum": [
        "web",
        "trusted"
      ],
      "description": "The type of application"
    },
    "trustedScope": {
      "type": "string",
      "enum": [
        "webdav",
        "ftp",
        "cmis"
      ],
      "description": "The scope identifier for a trusted application"
    },
    "trustedHost": {
      "type": "string",
      "description": "The host for a trusted application"
    },
    "deployments": {
      "type": "object",
      "properties": {
        "webhost": {
          "type": "string"
        },
        "domain": {
          "type": "string"
        },
        "clientId": {
          "type": "string"
        },
        "authGrantId": {
          "type": "string"
        },
        "baseURL": {
          "type": "string"
        }
      }
    },
    "source": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "public": {
          "type": "boolean"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "public": {
      "type": "object",
      "properties": {
        "runAsPrincipalId": {
          "type": "string"
        },
        "emailProviderId": {
          "type": "string"
        },
        "userDomainId": {
          "type": "string"
        },
        "tenantRegistrarId": {
          "type": "string"
        }
      }
    },
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  },
  "id": "application"
}

Application

Table of Contents

Parent

Objects

Properties

Methods

Add Team Member

Parameters

Response

Applicationtypes

Parameters

Response

Check Membership

Parameters

Response

Check Permission

Parameters

Response

Check Single Authority

Parameters

Response

Check multiple Authorities

Parameters

Response

Check multiple Permissions

Parameters

Response

Create Application

Parameters

Response

Create Application

Parameters

Response

Create a Team

Parameters

Response

Creates a role for an application

Parameters

Response

Delete Application

Parameters

Response

Delete Application

Parameters

Response

Deletes a Team

Parameters

Response

Deletes a role for an application

Parameters

Response

Deletes a role for an application

Parameters

Response

Deploys an application

Parameters

Response

Gathers statistics for an application

Parameters

Response

Get Team

Parameters

Response

Grant Authority

Parameters

Response

Grant Authority to Team

Parameters

Response

List Team Authorities

Parameters

Response

List Teams

Parameters

Response

Lists Application

Parameters

Response

Lists Application

Parameters