Operations with Backend Services Projects

Operations with Backend Services Projects

Projects are the core part of the Backend Services service model. The Backend Services project holds all data and other resources necessary for the functioning of your app's backend. Each Telerik Platform app can have exactly one Backend Services project.

Project Object Fields

In the following table you can find the fields of the project object.

Field Name Field Type Description Restrictions
Name Text Name of the app. Unique, Identifier
Title Text Title of the app. None
Description Text Description of the app. None
Owner Id The ID of the account that owns the app. Read-only
APIKey Text The App ID of the Telerik Platform app. Read-only
APIMasterKey Text The master key for the app. Read-only
DefaultRoleId Id The ID of the default role for the app. New users are set to this role, if no role is specified. Valid role ID
FilesContentTypeId Id The ID of the Files content type. Used to set permissions for files. Read-only
IsSample Yes/No True if the app is a sample app (created with the sample template). Read-only
IsAutogeneratedSample Yes/No True for projects containing sample data for the Friends app. Read-only
AccountId Id The AccountId for your account. Read-only
Settings Object Contains the settings object for the project. Read-only
DisableCloudCodeLog Yes/No If True, cloud code executions will not be logged. Read-only
DisableCloudCodeLog Yes/No If True, cloud code executions will not be logged. Read-only

Get a Project by ID

There are two ways to get information about a single project: by project ID or by App ID. Both will return the same result.

To get information about a single project using the app's App ID use the following example:

//Ajax request using jQuery
$.ajax({
    url: 'https://api.everlive.com/v1/Metadata/Applications/your-app-id'
    type: "GET",
    headers: { "Authorization" : "Masterkey your-master-key" },
    success: function(data){
        alert(JSON.stringify(data));
    },
    error: function(error){
        alert(JSON.stringify(error));
    }
})
Request:
    GET https://api.everlive.com/v1/Metadata/Applications/your-app-id
Headers:
    Authorization  Masterkey 
Response:
    Status: 200 OK
    Content-Type: application/json

Creating, Updating, and Deleting Projects

The operations for creating, updating, and deleting projects do not have a counterpart in the RESTful API. You need to leverage the Telerik Platform portal to perform these actions.

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.