What's on this page

Assembly Configuration

Get all Configurations

Returns a list of all the existing Behaviour Test configurations within a single Behaviour Test Project.

Request Format

Aspect Value
Endpoint URL /api/behaviour/assemblyConfigurations/{projectId}
HTTP Method GET

Request parameters

Parameter Name Description Mandatory
id Unique identifier for the Behaviour Test Project. This can be any text string. Yes

Response Format

Aspect Value
Response Code 200 – OK 404 – Requested Behaviour Test Project not found

Example Response Body

For a 200 Response Code:

 

[

  {

​    "properties": {

​      "additionalProp1": "string",

​      "additionalProp2": "string",

​      "additionalProp3": "string"

​    },

​    "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

​    "name": "test",

​    "projectId": "assembly::Test::1.0",

​    "description": "description",

​    "descriptorName": "assembly::Test::1.0",

​    "createdAt": "2019-03-01T10:07:21.289Z",

​    "lastModifiedAt": "2019-03-01T10:07:21.289Z"

  }

]

For a 40x, 500 or any other error response please see error responses

Response Body content type: application/json

Response properties

Property Name Description Mandatory
id Unique identifier of the Assembly Configuration instance Yes
name Textual, human readable name of the Assembly Configuration instance No
description User supplied textual description of the Assembly Configuration instance Yes
projectId Unique identifier for the Behaviour Test Project to which is piece of Assembly configuration relates. This can be any text string, it is not limited to GUIDs. Yes
descriptorName Textual name of the Assembly Descriptor used No
createdAt Date and time the Assembly Configuration instance was created Yes
lastModifiedAt Date and time the Assembly Configuration instance was last modified Yes
properties An array of Name-Value pairs where each pair defines one configuration parameter and its associated value. Yes

Get a single Configuration

Returns a single item of Behaviour Test configuration information.

Request Format

Aspect Value
Endpoint URL /api/behaviour/assemblyConfigurations/{assemblyConfigurationId}
HTTP Method GET

Request parameters

Parameter Name Description Mandatory
assemblyConfigurationId Unique identifier for the piece of Behaviour Test configuration information to be returned. This can be any text string. Yes

Response Format

Aspect Value
Response Code 200 – OK 404 – No matching configuration information found

Example Response Body

For a 200 Response Code:

{

  "properties": {

​    "additionalProp1": "string",

​    "additionalProp2": "string",

​    "additionalProp3": "string"

  },

  "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

  "name": "test",

  "projectId": "assembly::Test::1.0",

  "description": "description",

  "descriptorName": "assembly::Test::1.0",

  "createdAt": "2019-03-01T10:07:21.289Z",

  "lastModifiedAt": "2019-03-01T10:07:21.289Z"

}

 

For a 40x, 500 or any other error response please see error responses

Response Body content type: application/json

Response properties

Parameter Description Mandatory
id Unique identifier of the new Assembly Configuration instance. This can be any text string provided it is unique within LM instance. It is not limited to GUIDs. Yes
name Textual, human readable name of the Assembly Configuration instance Yes
description Textual description of the Assembly Configuration instance Yes
projectId Unique identifier for the Behaviour Test Project to which is piece of Assembly configuration relates. This can be any text string, it is not limited to GUIDs. This Behaviour Test Project must already exist Yes
descriptorName Name of the Test Assembly template from which the any Assembly using this configuration will be created. Yes
properties An array of Name-Value pairs where each pair defines one configuration parameter and its associated value. Yes

Create a new Configuration

Creates a new Assembly Configuration and associates it with an existing Behaviour Test project.

Request Format

Aspect Value
Endpoint URL /api/behaviour/assemblyConfigurations
HTTP Method POST

Example Request Body

Request Body content type: application/json

 

{

  "properties": {

​    "additionalProp1": "string",

​    "additionalProp2": "string",

​    "additionalProp3": "string"

  },

  "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

  "name": "test",

  "projectId": "assembly::Test::1.0",

  "description": "description",

  "descriptorName": "assembly::Test::1.0",

}

Request parameters

Parameter Description Mandatory
id Unique identifier of the new Assembly Configuration instance. This can be any text string provided it is unique within LM instance. It is not limited to GUIDs. Yes
name Textual, human readable name of the Assembly Configuration instance Yes
description Textual description of the Assembly Configuration instance Yes
projectId Unique identifier for the Behaviour Test Project to which is piece of Assembly configuration relates. This can be any text string, it is not limited to GUIDs. This Behaviour Test Project must already exist Yes
descriptorName Name of the Test Assembly template from which the any Assembly using this configuration will be created. Yes
properties An array of Name-Value pairs where each pair defines one configuration parameter and its associated value. Yes

Response Format

Aspect Value
Response Code 201 – Assembly Configuration successfully created. 400 – Assembly Configuration has invalid properties. 409 – An Assembly Configuration with the same ID already exists.

For a 40x, 500 or any other error response please see error responses

Update an existing Configuration

Update the contents of an existing Assembly Configuration

Request Format

Aspect Value
Endpoint URL /api/behaviour/assemblyConfigurations/{assemblyConfigurationId}
HTTP Method PUT

Request parameters

Parameter Name Description Mandatory
assemblyConfigurationId Unique identifier for the piece of Assembly configuration information to be updated. This can be any text string. Yes

Example Request Body

Request Body content type: application/json



{

  "properties": {

​    "additionalProp1": "string",

​    "additionalProp2": "string",

​    "additionalProp3": "string"

  },

  "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

  "name": "test",

  "projectId": "assembly::Test::1.0",

  "description": "description",

  "descriptorName": "assembly::Test::1.0",

}

 


Request parameters

Parameter Description Mandatory
id Unique identifier of the Assembly Configuration instance. This can be any text string provided it is unique within LM instance. It is not limited to GUIDs. Yes
name Textual, human readable name of the Assembly Configuration instance Yes
description Textual description of the Assembly Configuration instance Yes
projectId Unique identifier for the Behaviour Test Project to which is piece of Assembly configuration relates. This can be any text string, it is not limited to GUIDs. This Behaviour Test Project must already exist Yes
descriptorName Name of the Test Assembly template from which the any Assembly using this configuration will be created. Yes
properties An array of Name-Value pairs where each pair defines one configuration parameter and its associated value. Yes

Response Format

Aspect Value
Response Code 200 – Assembly Configuration successfully updated. 404 – Matching Assembly Configuration not found.

Example Response Body

For a 200 Response Code:

Response Body content type: application/json

{

  "properties": {

​    "additionalProp1": "string",

​    "additionalProp2": "string",

​    "additionalProp3": "string"

  },

  "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

  "name": "test",

  "projectId": "assembly::Test::1.0",

  "description": "description",

  "descriptorName": "assembly::Test::1.0",

  "createdAt": "2019-03-01T10:07:21.289Z",

  "lastModifiedAt": "2019-03-01T10:07:21.289Z"

}

 

For a 40x, 500 or any other error response please see error responses

Response properties

Property Name Description Mandatory
id Unique identifier of the Assembly Configuration instance Yes
name Textual, human readable name of the Assembly Configuration instance Yes
description User supplied textual description of the Assembly Configuration instance Yes
projectId Unique identifier for the Behaviour Test Project to which is piece of Assembly configuration relates. This can be any text string, it is not limited to GUIDs. Yes
descriptorName Name of the Test Assembly template from which the any Assembly using this configuration will be created. Yes
createdAt Date and time the Assembly Configuration instance was created Yes
lastModifiedAt Date and time the Assembly Configuration instance was last modified Yes
properties An array of Name-Value pairs where each pair defines one configuration parameter and its associated value. Yes

Remove a Configuration

Remove an existing Assembly Configuration

Request Format

Aspect Value
Endpoint URL /api/behaviour/assemblyConfigurations/{assemblyConfigurationId}
HTTP Method DELETE

Request parameters

Parameter Name Description Mandatory
assemblyConfigurationId Unique identifier for the piece of Assembly configuration information to be removed. This can be any text string. Yes

Response Format

Aspect Value
Response Code 200 – Assembly Configuration successfully removed. 404 – Matching Assembly Configuration not found.

Example Response Body

For a 40x, 500 or any other error response please see error responses