Projects

List All

Finds all projects (full JSON representation) contained in the Organization identified by orgId.

HTTP REQUEST: GET

GET/api/1.0/org/{orgId}/projects

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

Clone

Outputs a JSON object - essentially a, clone of the specified project - with new IDs generated for all objects and references.

HTTP REQUEST: GET

GET/api/1.0/org/{orgId}/project/{projectId}/clone

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

Read as XML

Reads the project identified by projectId in the endpoint and returns the XML representations.

HTTP REQUEST: GET

GET/api/1.0/org/{orgId}/project/{projectId}/xml

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

Projects

Manages Projects and Project Metadata.

HTTP REQUEST: GET

Reads the project identified by projectId in the endpoint and returns the JSON representations.

GET/api/1.0/org/{orgId}/project/{projectId}

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

HTTP REQUEST: PUT

Updates the project identified by projectId in the endpoint and returns the JSON representations. Payload is a Project represented as JSON. There are two important things to consider. First, since project's cubes are identified only by their Cube ID, you should take care to keep the existing Cube IDs unchanged. If the update removes an existing Cube ID, then that cube's aggregates will be deactivated on publish. Second, if a project contains a new Cube ID, then that cube will receive the default, run-time security settings, and also will not have any aggregates when published. Cube ID's are likely to be different in Project files exported from different AtScale installations. Please verify that the Project definition contains the expected Cube ID's before proceeding with the project update.

PUT/api/1.0/org/{orgId}/project/{projectId}

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

HTTP REQUEST: PATCH

Manages Project Metadata update. Metadata supported are display name, query name, description and predictive aggregates.

PATCH/api/1.0/org/{orgId}/project/{projectId}

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

Request Body

{
  "display_name": "new name",
  "renaming_query_name": "new query name",
  "description": "new description",
  "updating_description": true,
  "prediction_def_aggs": "prediction defined aggregates"
}

HTTP REQUEST: DELETE

Deletes the project identified by projectId.

DELETE/api/1.0/org/{orgId}/project/{projectId}

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

Create

Pulls the JSON or XML representation of the Project from the body of the request and attempts to marshal into the Project structure and persist it.

HTTP REQUEST: POST

POST/api/1.0/org/{orgId}/project

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
Content-Type	string	The Organization ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

RESPONSE BODY DESCRIPTIONS

Name	Type	Description
id	string	-
name	string	-
description	string	-
version	integer	-
created	integer	-
createdBy	string	-

Convert from JSON to XML

Takes a JSON representation of a Project and converts it to XML.

HTTP REQUEST: POST

POST/api/1.0/org/{orgId}/xml

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

Convert from XML to JSON

This API takes a JSON representation of a Project and converts it to JSON.

HTTP REQUEST: POST

POST/api/1.0/org/{orgId}/json

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

Publish

Publishing a project publishes all of the cubes contained in the project. You cannot publish cubes individually.

HTTP REQUEST: POST

POST/api/1.0/org/{orgId}/project/{projectId}/publish

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID (UUID) for which you are querying.

RESPONSES

Code	Description
200	Success.
401	This error will occur if calling user does not have access right for the API.
404	This error will occur if calling user does not have access right for the API.
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

Request Body

{
  "version_tag": "v1.0",
  "modifications": {
    "display_name": "New Publish Project Caption",
    "query_name": "new_query_name",
    "project_id": "59e54b54-7101-4380-5397-6bd771d331f8"
  }
}

200 Response Body

{
  "status": {
    "code": 200,
    "i18n_message": "response.ok",
    "message": "ok"
  },
  "response": {
    "id": "abc123"
  },
  "time_to_process": "1.1 seconds"
}

Additional Reference

Design Center API REFERENCE

Projects

List All

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

Clone

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Read as XML

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Projects

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

HTTP REQUEST: PUT

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

HTTP REQUEST: PATCH

URI PARAMETERS

RESPONSES

HTTP REQUEST: DELETE

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Create

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Convert from JSON to XML

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

Convert from XML to JSON

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

Publish

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES