Project Management
Projects
Project management in Altair SmartCore.
CreateCreate a project
| URL: | https://api.altairsmartcore.com/projects/ |
| HTTP method: | POST |
Attributes:
| Attribute | Description |
|---|---|
| name (mandatory) |
Text. 50 characters max. Unique. Project name. Example: newProject |
| id_customer (mandatory) |
Text. Projects client ID. Example: @smartcore.smartcore |
| description (optional) |
Text. 200 characters max. Project description. Example: New Project |
| enabled (optional) |
Boolean. Valid values: 0, 1, true or false. Project enabled, default true. Example: true |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code:2001 messsage: Project created details: |
| 400 |
Request not valid Possible values: - code:4001 messsage: Json bad formed details: - code:4003 messsage: validation error details: {field: error message,...} |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
POST https://api.altairsmartcore.com/projects/
Response example:
Show a project
| URL: | https://api.altairsmartcore.com/projects/{project_id_developer}/ |
| HTTP method: | GET |
| Response: | json/xml |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - Project JSON object |
| 400 |
Request not valid Possible values: - code:4004 messsage: format parameter invalid details: {field: error message,...} |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
GET https://api.altairsmartcore.com/projects/newProject@smartcore.smartcore/
Response example:
Project list, max 1000
| URL: | https://api.altairsmartcore.com/projects/ |
| HTTP method: | GET |
| Response: | json/xml |
Parameters:
| Attribute | Description |
|---|---|
| name (optional) |
Text. 50 characters max. Filter list result by field name. Example: newProject |
| id_developer (optional) |
Text. 50 characters max. Filter list result by field id_developer. Example: newProject@smartcore.smartcore |
| enabled (optional) |
Boolean. Valid values: 0, 1, true or false. Filter list result by field enabled. Example: true |
| owner (optional) |
Username. Filter list result by field owner. Example: smartcore |
| updater (optional) |
Username. Filter list result by field updater. Example: smartcore |
| created_at (optional) |
Timestamp. Filter list result by field created_at. Example: 1337009328 to and from modificators allows to specify a range. Extreme values are included. Example: created_at=1337009328 |
| max (optional) |
Integer. Values between 1 and 1000. Defines the number of results to be returned. Max and default value is 1000. Example: 250 |
| sort (optional) |
Field name. Sort the result by the given field. Default value is name. Example: creation_date |
| order (optional) |
Integer. Valid values: -1 or 1 Result order criteria: -1 for descending and 1 for ascending. Example: -1 |
| offset (optional) |
Integer. Result offset. List will begin at the given offset. Example: 100 |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: -total_documents result numbers result: Project JSON object set |
| 400 |
Request not valid Possible values: - code:4004 messsage: format parameter invalid details: {field: error message,...} |
| 503 |
Project Management Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
GET https://api.altairsmartcore.com/projects/
Response example:
Update a project
| URL: | https://api.altairsmartcore.com/projects/{project_id_developer}/ |
| HTTP method: | PUT |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code 2005 message: Project updated details: Project JSON object |
| 400 |
Request not valid Possible values: - code:4001 messsage: nonexistent file details: - code:4003 messsage: validation error details: {field: error message,...} - code:4004 messsage: format parameter invalid details: {field: error message,...} - code:4005 messsage: concurrency error details: {version: |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
PUT https://api.altairsmartcore.com/projects/newProject@smartcore.smartcore/
Response example:
Delete a project
| URL: | https://api.altairsmartcore.com/projects/{project_id_developer}/ |
| HTTP method: | DELETE |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code 2004 message: Project deleted details: |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
DELETE https://api.altairsmartcore.com/projects/newProject@smartcore.smartcore/
Response example:
Show a service from a project
| URL: | https://api.altairsmartcore.com/projects/{project_id_developer}/services/{service_id_developer}/ |
| HTTP method: | GET |
| Response: | json/xml |
Request example:
https://api.altairsmartcore.com/projects/defaultProject@smartcore.smartcore/services/defaultService@smartcore.smartcore/
Response example:
List of services from a project, max 1000.
| URL: | https://api.altairsmartcore.com/projects/{project_id_project}/services/ |
| HTTP method: | GET |
| Response: | json/xml |
Request example:
GET https://api.altairsmartcore.com/projects/defaultProject@smartcore.smartcore/services/
Response example:
Services
Service management in Altair SmartCore.
CreateCreate a service
| URL: | https://api.altairsmartcore.com/services/ |
| HTTP method: | POST |
Attributes:
| Attribute | Description |
|---|---|
| name (mandatory) |
Text. 50 characters max. Unique. Service name. Example: newService |
| id_project (mandatory) |
Text. Project identifier Example: defaultProject@smartcore.smartcore |
| description (optional) |
Text. 200 characters max. Service description. Example: New Service |
| enabled (optional) |
Boolean. Valid values: 0, 1, true or false. Filter list result by field enabled. Example: true |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code 2001 message: Service created details: |
| 400 |
Request not valid Possible values: - code: 4001 message: Json bad formed details: - code: 4003 message: validation error details: {field: error message,...} |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
POST https://api.altairsmartcore.com/services/
Response example:
Service data
| URL: | https://api.altairsmartcore.com/services/{service_id_developer}/ |
| HTTP method: | GET |
| Response: | json/xml |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - Device JSON object |
| 400 |
Request not valid Possible values: - code: 4004 message: format parameter invalid details: {field: error message,...} |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
GET https://api.altairsmartcore.com/services/newService@smartcore.smartcore/
Response example:
Service list, max. 1000
| URL: | http://api.altairsmartcore.com/services/ |
| HTTP method: | GET |
| Response: | json/xml |
Parameters:
| Attribute | Description |
|---|---|
| name (optional) |
Text. 50 characters max. Filter list result by field name. Example: newService |
| id_developer (optional) |
Text. Filter list result by field id_developer. Example: newService@smartcore.smartcore |
| enabled (optional) |
Boolean. Valid values: 0, 1, true or false. Filter list result by field enabled. Example: true |
| owner (optional) |
Username. Filter list result by field owner. Example: smartcore |
| updater (optional) |
Username. Filter list result by field updater. Example: smartcore |
| created_at (optional) |
Timestamp. Filter list result by field created_at. Example: 1353794782 to and from modificators allows to specify a range. Extreme values are included. Example: created_at=1353794782 |
| max (optional) |
Integer. Values between 1 and 1000. Defines the number of results to be returned. Max and default value is 1000. Example: 250 |
| sort (optional) |
Field name. Sort the result by the given field. Default value is name. Example: creation_date |
| order (optional) |
Integer. Valid values: -1 or 1 Result order criteria: -1 for descending and 1 for ascending. Example: -1 |
| offset (optional) |
Integer. Result offset. List will begin at the given offset. Example: 100 |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - total_documents: result numbersresult: Service JSON object set |
| 400 |
Request not valid Possible values: - code: 4004 message: format parameter invalid details: {field: error message,...} |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
GET https://api.altairsmartcore.com/services/
Response example:
Update service
| URL: | https://api.altairsmartcore.com/services/{service_id_developer}/ |
| HTTP method: | PUT |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code: 2005 message: Service updated details: Service JSON object |
| 400 |
Request not valid Possible values: - code: 4001 message: nonexistent file details: - code: 4003 message: validation error details: {field: error message,...} - code: 4004 message: format parameter invalid details: {field: error message,...} - code: 4005 message: concurrency error details: {version: |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
PUT https://api.altairsmartcore.com/services/newService@smartcore.smartcore/
Response example:
Delete a service
| URL: | https://api.altairsmartcore.com/services/{service_id_developer}/ |
| HTTP method: | DELETE |
Response codes
| Code | Description |
|---|---|
| 200 |
Operation successfull Possible values: - code: 2004 message: Service deleted details: |
| 404 | Resource not found |
| 503 |
Service unavailable. - code: 5031 message: BD error details: - code: 5032 message: exception details: {message: |
Request example:
DELETE https://api.altairsmartcore.com/services/newService@smartcore.smartcore/
Response example:
Show a group from a service
| URL: | https://api.altairsmartcore.com/services/{service_id_developer}/groups/{group_id_developer}/ |
| HTTP method: | GET |
| Response: | json/xml |
Request example:
GET https://api.altairsmartcore.com/services/defaultService@smartcore.smartcore/groups/defaultGroup@smartcore.smartcore/
Response example:
Group list from a service, max 1000
| URL: | https://api.altairsmartcore.com/services/{service_id_developer}/groups/ |
| HTTP method: | GET |
| Response: | json/xml |
Request example:
GET https://api.altairsmartcore.com/services/defaultService@smartcore.smartcore/groups/
Response example: