API for Administration

body

no

-

string

body

yes

Object of user to be created

-

User

body

yes

Object of maprole having details of project roles to be assigned while creating user

-

MapRole

200

User created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

no

-

string

body

yes

Object of user to be updated

-

UpdateUser

body

yes

Object of maprole having details of project roles to be assigned while updating user

-

MapRole

200

User created successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

header

yes

application/json

-

string

header

yes

Open API key

-

string

header

yes

default

-

string

200

Successful operation.

ResponseEntity

500

Returned if there is an error in server

-

body

no

provide start

-

integer

body

no

provide limit

-

integer

body

no

provide page

-

integer

200

List of users

ResponseEntityString

400

Invalid json object or mandatory fields missing or export operation failed.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Unique identifier of user to be deactivated

-

integer

body

yes

Send 'false' to deactivate user

-

boolean

200

User deactivated successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Unique identifier of user to delete

-

integer

200

User deleted successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Start index of records

-

integer

body

yes

Number of records per page

-

integer

body

yes

Page number to be displayed

-

integer

200

List of roles shown successfully.

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Start index of records

-

integer

body

yes

Number of records per page

-

integer

body

yes

Page number to be displayed

-

integer

body

yes

Id of role to get execution statuses specific to that role

-

integer

body

no

Send 'true' to show archived platforms (defaulted to false)

-

boolean

body

no

Sort parameters

-

Array[Sort]

200

list of execution statuses shown successfully

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Start index of records

-

integer

body

yes

Number of records per page

-

integer

body

yes

Page number to be displayed

-

integer

body

yes

Unique identifier of project whose field list has to be obtained

-

integer

body

no

Send True to get System fields and false to get User fields. Defaulted to false

-

boolean

200

List of fields successfully created

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Start index of records

-

integer

body

yes

Number of records per page

-

integer

body

yes

Page number to be displayed

-

integer

200

List of system defined and user defined components

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

ID of custom list whose list values are to be obtained

-

integer

body

yes

Start index of records

-

integer

body

yes

Number of records per page

-

integer

body

yes

Page number to be displayed

-

integer

body

yes

Parameters

-

Param2

200

List of all the values of the custom list

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

ListValues to add

-

Array[ListValue]

body

yes

Name of list

-

string

200

Customlist added successfully

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Unique identifier of list which is to be updated

-

integer

body

yes

Provide listValues to be deleted

-

Array[ListValue]

body

yes

ListValues

-

Array[ListValue]

200

Custom list updated

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Unique identifier of Custom-list

-

integer

200

Custom-list successfully deleted

ResponseEntity

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

start index of records

-

integer

body

yes

number of records per page (max. value 50)

-

integer

body

yes

page number

-

integer

body

yes

start date to filter the records (date format as per set in User Profile)

-

string

body

yes

end date of records (date format as per set in User Profile)

-

string

200

List of audit logs

ArrayOfDataElements

400

Invalid json object or mandatory fields missing or export operation failed.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Type of Repository (e.g., GIT, BITBUCKET, SVN)

-

string

body

yes

URL of configured Repository

-

string

body

yes

Username to access repository

-

string

body

yes

Password to access repository.

Note: The password should be in base64 encoded string. You can use https://www.base64encode.org/ to encode the password in base64 format.

-

string

body

yes

Instance type of repository i.e. Server or Cloud

-

string

body

no

Accesstoken for access repository.

-

string

body

yes

ID of project for which you want to configure the BDD repository

-

integer

200

List of folders fetched successfully

ResponseEntityString

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

ID of project for which you want list of BDD repository

-

integer

query

no

The index of the first item to return in a page of results

-

integer

query

no

The maximum number of items to return per page. The maximum is 50.

-

integer

query

no

The page number.

-

integer

200

Configured Repository's list fetched successfully

ResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Type of Repository (e.g., GIT, BITBUCKET, SVN).

-

string

body

yes

URL of the configured Repository

-

string

body

yes

Username to access repository.

-

string

body

yes

Password to access repository.

Note: The password should be in base64 encoded string. You can use https://www.base64encode.org/ to encode the password in base64 format.

-

string

body

yes

Instance type of repository i.e. Server or Cloud

-

string

200

Repository was verified successfully.

ResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

Type of Repository (e.g., GIT, BITBUCKET, SVN).

string

body

yes

URL of the configured Repository

string

body

yes

Username to access the repository.

string

body

yes

Password to access the repository.

Note: The password should be in base64 encoded string. You can use https://www.base64encode.org/ to encode the password in base64 format.

string

body

yes

Instance type of repository i.e. Server or Cloud

-

string

body

yes

ID of BDD repository for particular project from DB.

integer

200

Repository was updated successfully.

ResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

ID of BDD repository for particular project from DB.

-

integer

200

Repository was deleted successfully.

ResponseEntity

400

Missing mandatory fields.

-

401

Unauthorised or session expired

-

500

Returned when server connection times out

-

body

yes

ID of labels list whose list values are to be obtained.

-

integer

body

no

Mode of operation like EDIT,ADD.

-

string

body

no

Start index of records.

-

integer

body

no

Number of records per page.

-

integer

body

no

Page number to be displayed.

-

integer

body

no

Parameters

-

Param2

body

no

ID of project for which possible labels list values to be obtained

-

integer

200

List of all the values of the LabelsLi

ResponseEntity

201

Created

-

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

403

Forbidden

-

404

Not Found

-

500

Returned when server connection times out

-

body

yes

Unique identifier of labels list which is to be updated

-

integer

body

yes

Provide listValues to be deleted

-

Array[ListValue]

body

yes

ListValues

-

Array[ListValue]

200

Label list updated

ResponseEntity

201

Created

-

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

403

Forbidden

-

404

Not Found

-

500

Returned when server connection times out

-

body

yes

JsonArray of Requests

-

JsonArray

200

Batch requests executed successfully

ResponseEntityString

400

Invalid json object or mandatory fields missing

-

401

Unauthorised or session expired

-

429

Returned when more than 10 requests are passed for batch execution

-

500

Returned when server connection times out

-

headers

object

optional

-

body

object

optional

-

statusCode

string

optional

-

showInActive

boolean

optional

Send true to see deactivated users as well(defaulted to false)

name

string

required

Name of list value

alias

string

required

Alias of list value

createdDate

string

required

Created date of the list value

Value

string

required

weightage of the list value

Id

integer

required

ID of list value to update/delete, '0' when list value is to be added

showArchive

boolean

required

Send 'true' to show archived entities

property

string

optional

-

direction

string

optional

-

accessLogID

long

actionName

string

accessDate

string

accessUser

string

projectName

string

moduleName

string

entityKey

string

id

string

projectID

integer

version

string

message

string

screenName

string

userActionName

string

isActive

boolean

optional

True is user is active, else false

userType

integer

required

Type of user

isLabel

boolean

optional

True if its a label

loginId

string

required

Login id of user

userAlias

string

required

Alias of user

firstName

string

required

Firstname of user

lastName

string

required

Lastname of user