Project

Options

The Organization ID (UUID) for which you are querying.

HTTP REQUEST: GET

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

URI PARAMETERS

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

RESPONSES

Code	Description
200	Success.
400	This error will occur if the project with the specified projectId does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist
500	A server error occurred. Check the logs for more details.

200 Response Body

{
  "id": "abc123",
  "can_update,omitempty": true,
  "can_delete": true
}

Create New/Empty

HTTP REQUEST: POST

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

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) where the new project should be created

QUERY PARAMETERS

Name	Type	Description
name	string	The name of the new project
speculative-aggregate	boolean	Enable prediction-defined aggregates for the new project
inclusive-access	boolean	Enable inclusive access for the new project

RESPONSES

Code	Description
200	Success.
400	This error will occur if the project with the specified projectId does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist.
500	A server error occurred. Check the logs for more details.

Request Body

{
  "name": "Project 35",
  "speculative-aggregate": false,
  "inclusive-access": false
}

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "428d790c-9e8a-472f-6dde-49f6fe43d9ac",
    "name": "Project 35",
    "annotations": {
      "annotation": [
        {
          "name": "migrationVersion",
          "value": "0.0.0.0"
        }
      ]
    },
    "properties": {
      "caption": "Project 35",
      "visible": true,
      "aggressive_aggregate_promotion": false,
      "aggregate-prediction": {
        "speculative-aggregates": true
      },
      "preferred_aggregate_stores": {
        "agg_stores_by_priority": null
      }
    },
    "datasets": {},
    "cubes": {
      "cube": [
        {
          "id": "3fc04818-b3ea-468f-67dd-46883a987c80",
          "name": "Project 35"
        }
      ]
    },
    "createdBy": "bootstrap"
  }
}

Rename

HTTP REQUEST: POST

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

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	ID (UUID) of the project you want to rename

RESPONSES

Code	Description
200	Success.
400	This error will occur if the org with the specified OrganizationID does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist
500	A server error occurred. Check the logs for more details.

RESPONSE BODY DESCRIPTIONS

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

Request Body

{
  "newName": "Renamed Project"
}

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "21c0ee1e-8d7d-499c-475f-a8af7c24c532",
    "name": "Project",
    "version": 1,
    "properties": {
      "caption": "Renamed Project",
      "visible": true,
      "aggregate-prediction": {
        "speculative-aggregates": false
      }
    },
    "datasets": {},
    "cubes": {
      "cube": [
        {
          "id": "a6919016-ea66-408f-4c5e-56270ffd6643",
          "name": "Cube",
          "properties": {
            "caption": "Cube",
            "visible": false
          }
        }
      ]
    }
  }
}

Check if exists by name

HTTP REQUEST: POST

POST/api/1.0/org/{orgId}/project/{projectId}/{name}/verify

URI PARAMETERS

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

RESPONSES

Code	Description
200	Success.
400	This error will occur if the org with the specified OrganizationID does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist
409	This project already exists
500	A server error occurred. Check the logs for more details.

RESPONSE BODY DESCRIPTIONS

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

Permission Properties

HTTP REQUEST: GET

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

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.
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.

200 Response Body

{
  "response": {
    "designtime_permissions": [
      {
        "name": "project.read",
        "id": "project.read"
      },
      {
        "name": "project.update",
        "id": "project.update"
      },
      {
        "name": "project.delete",
        "id": "project.delete"
      },
      {
        "name": "project.publish",
        "id": "project.publish"
      }
    ]
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Permissions

HTTP REQUEST: GET

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

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID 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.

200 Response Body

{
  "response": {
    "designtime_permissions": {
      "designtime_permission_matrix": {
        "568a4ab9-f7a4-4ac2-5162-9a496453d161": [
          "project.read"
        ],
        "admin1234": [
          "project.read",
          "project.update",
          "project.delete",
          "project.publish"
        ],
        "f1edfca6-7f8a-4a4d-7952-4660580c67a2": [
          "project.read"
        ]
      },
      "permissions": [
        {
          "name": "project.read",
          "id": "project.read"
        },
        {
          "name": "project.update",
          "id": "project.update"
        },
        {
          "name": "project.delete",
          "id": "project.delete"
        },
        {
          "name": "project.publish",
          "id": "project.publish"
        }
      ],
      "users": [
        {
          "user_id": "568a4ab9-f7a4-4ac2-5162-9a496453d161",
          "auth_username": "abc",
          "name": "abc",
          "super_user": false,
          "api_super_user": false,
          "email": "abc@atscale.com"
        }
      ]
    },
    "object_properties": {
      "exclusive_access": true,
      "author_user_id": "abc",
      "object_type": "project",
      "object_id": "58e262f8-3ec6-4835-4890-60e8ab51e76b"
    },
    "admins": [
      "admin1234"
    ]
  },
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

HTTP REQUEST: POST

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

URI PARAMETERS

Name	Type	Description
orgId	string	The Organization ID (UUID) for which you are querying.
projectId	string	The Project ID 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

{
  "designtime_permission_matrix": {
    "admin1234": [
      "project.read",
      "project.update",
      "project.delete",
      "project.publish"
    ],
    "b9f64bf0-a599-49fb-7ddd-0dc0a73f86c0": [
      "project.read",
      "project.update",
      "project.delete",
      "project.publish"
    ]
  },
  "exclusive_access_run_time": false,
  "exclusive_access_design_time": false
}

200 Response Body

{
  "response": "Succesfully updated the permissions",
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  }
}

Snapshots Read & Create

HTTP REQUEST: GET

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

URI PARAMETERS

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

RESPONSES

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

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "snapshot_id": "b4a1da7a-8bbd-4f01-4ac9-7be629d50258",
      "name": "B",
      "project_id": "3d50753c-be0c-4528-6a4e-9c62f58394ca",
      "create_date": "2019-05-03T18:42:05.281857Z",
      "user_id": "admin1234",
      "Project": {}
    },
    {
      "snapshot_id": "74dcd3f8-01df-4057-7126-08c2fa71257c",
      "name": "A",
      "project_id": "3d50753c-be0c-4528-6a4e-9c62f58394ca",
      "create_date": "2019-05-03T18:36:32.500596Z",
      "user_id": "admin1234",
      "Project": {}
    }
  ]
}

HTTP REQUEST: POST

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

URI PARAMETERS

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

RESPONSES

Code	Description
200	Success.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist.
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

{
  "tag": "emptyCube"
}

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "snapshot_id": "ac0adc31-4fbb-4abd-7976-280fb90e0555",
    "name": "emptyCube",
    "project_id": "59e54b54-7101-4380-5397-6bd771d331f8",
    "create_date": "2018-03-29T23:49:04.97762Z",
    "user_id": "admin1234",
    "Project": {}
  }
}

Snapshots Delete

HTTP REQUEST: DELETE

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

URI PARAMETERS

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

RESPONSES

Code	Description
200	Success.
400	This error will occur if the project snapshot with the specified projectVersionId does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": "Successfully deleted project snapshot: [ac0adc31-4fbb-4abd-7976-280fb90e0555] for Project Id: [3d50753c-be0c-4528-6a4e-9c62f58394ca]"
}

Snapshots Restore

HTTP REQUEST: GET

GET/api/1.0/org/{orgId}/project/{projectId}/snapshots/{snapshotId}/restore

URI PARAMETERS

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

RESPONSES

Code	Description
200	Success.
400	This error will occur if the project snapshot with the specified projectVersionId does not exist.
403	This error will occur if calling user does not have access right for the API.
404	This error will occur if the project does not exist
500	A server error occurred. Check the logs for more details.
503	This error will occur if Design Center APIs are not enabled.

200 Response Body

{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": "Project [3d50753c-be0c-4528-6a4e-9c62f58394ca] succesfully restored from snapshot: [74dcd3f8-01df-4057-7126-08c2fa71257c]"
}

Additional Reference

Design Center API REFERENCE

Project

Options

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

Create New/Empty

HTTP REQUEST: POST

URI PARAMETERS

QUERY PARAMETERS

RESPONSES

Rename

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Check if exists by name

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

RESPONSE BODY DESCRIPTIONS

Permission Properties

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

Permissions

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

Snapshots Read & Create

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES

HTTP REQUEST: POST

URI PARAMETERS

RESPONSES

Snapshots Delete

HTTP REQUEST: DELETE

URI PARAMETERS

RESPONSES

Snapshots Restore

HTTP REQUEST: GET

URI PARAMETERS

RESPONSES