REST API

All REST API is located in api module and should be changed separately and with backward compatibility.

Without SSO configured Genesis use form-based (for browser usage) authorization and basic (for direct REST usage) authorization without challenge.

REST API Reference

Content

Core domain

Projects Management

Environments Management

Workflow execution management

Templates management

Supported domain extensions

Credentials management

Databags management

Predefined servers management

Configuration and security

Settings and build information

Users and groups management

System and project roles management

Environment access security

Common api

There is a common result object returning for most changing (POST and PUT) operations.

Example of successful response:

{
	"isSuccess": true,
	"isNotFound": false,
	"serviceErrors":{},
    	"variablesErrors":{},
    	"compoundServiceErrors":[],
    	"compoundVariablesErrors":[],
}

Example of errorneous response:

{
	"isSuccess": false,
	"isNotFound": false,
	"serviceErrors" : {"fieldName": "Error message"},
	"variablesErrors" : {"fieldName": "Error message"},
	"compoundServiceErrors" : ["Error message1", "Error message2"],
	"compoundVariableErrors" : ["Error message1", "Error message2"]
}

Fields description:

Field name	Type	Description
isSuccess	Boolean	Overall operation result
isNotFound	Boolean	Object that was requested or involved in operation is not found
serviceErrors	Map of field name / error message	Dictionary of service errors mapped to field names. Service error means that field value is valid but cannot be used in operation due to more complex requirements
variablesErrors	Map of field name / error message	Dictionary of service errors mapped to field names or variable errors. This map mostly contains validation errors
compoundServiceErrors	Array of error messages	List of errors that mostly due to combination of field values (possibly valid by themselves)
compoundVariableErrors	Array of error messages	List of errors that caused by invalid combination of field values