Targets API

Owned by Cole Chronowski (Unlicensed)
Last updated: May 20, 2022 by Muthu Sankaralingam
4 min read

Targets can be accessed and modified through this API using three services: GET, PUT, and PATCH. These three services allow for the retrieval, complete update, and partial update of targets.

Authentication - Use Basic Authentication for this API.

GET

This GET service will find a target  with the given environment id and instance id. It returns the JSON representation of the target. 

API URL

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/{environmentId}/{instanceId}

Request

Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return a target.
instanceIdURLYesURL parameter for the instance Id which is used to find and return a target.

Response

AttributesTypeDescription
environmentIdLongThe environment id of the target.
instanceIdLongThe instance id of the target.
isActiveBooleanWhether or not the target is active
endPointsList<EndPoint>List of endpoint ids and their associated resource type ids
propertiesList<PropertyValue>List of property names and their values

Endpoint, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
endPointIdLongEndpoint id mapped to target.
resourceTypeIdsList<Long>List of resource type id for endpoint mapping.
endPointNameString Name of the endpoint.
resourceNamesList<String>List of resources.

Property value, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
propertyNameStringProperty code
propertyValueStringProperty value
credentialIdLongId for the credential associated with property. Applicable only for encrypted properties
isExpressionBooleanIs the propertyValue a groovy expression?

Response Codes

HTTP CodeDescription
200Target was found and returned
401Authentication failure
403Authorization failure (no access to resource)
404Environment Instance not found
500Unexpected internal server error

Example

If we had a target in our database with an environment id of 12347 and an instance id of 12342, we can run a GET request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

The GET request would return the following JSON target object:

Environment Instance: 12347, 12342
{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		}
	],
	"environmentId": 12347,
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": null,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "*****",
			"credentialId": 74952,
			"isExpression": false
		}
	]
}

PUT

This PUT service will replace all attributes of a target with the given environment instance corresponding to the environment id and instance id provided in the url.

API URL

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/{environmentId}/{instanceId}

Request

Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return a target.
instanceIdURLYesURL parameter for the instance Id which is used to find and return a target.
environmentIdLongNoThe environment id of the target. This parameter is ignored in PUT.
instanceIdLongNoThe instance id of the target. This parameter is ignore in PUT.
isActiveBooleanNoWhether or not the target is active. Defaults to true if not passed in.
endPointsList<EndPoint>No

List of endpoint ids and their associated resource type ids. If currently associated Endpoint(s) are not in input list, then those Endpoint(s) will be unassigned from target along with any resource types.

i.e. at the end of successful request, target will have mapped Endpoint(s) matching to input request.

EndPoint contains endpointId and array of resourceIds.

propertiesList<PropertyValue>Yes

List of property names, their values, and credential id for encrypted properties. If target property does not have value in input list, then that property value will be cleared.

PropertyValue contains propertyName, propertyValue, and credentialId.

Response

AttributesTypeDescription
environmentIdLongThe environment id of the target.
instanceIdLongThe instance id of the target.
isActiveBooleanWhether or not the target is active
endPointsList<EndPoint>List of endpoint ids and their associated resource type ids
propertiesList<PropertyValue>List of property names and their values

Endpoint, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
endPointIdLongEndpoint id mapped to target.
resourceTypeIdsList<Long>List of resource type id for endpoint mapping.
endPointNameString Name of the endpoint.
resourceNamesList<String>List of resources.

Property value, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
propertyNameStringProperty code
propertyValueStringProperty value
credentialIdLongId for the credential associated with property. Applicable only for encrypted properties
isExpressionBooleanIs the propertyValue a groovy expression?

Response Codes

HTTP CodeDescription
200Target was found and updated
401Authentication failure
403Authorization failure (no access to resource)
404Environment Instance not found
500Unexpected internal server error

Example

If we had a target in our database with an environment id of 12347 and an instance id of 12342 with the following attributes,

Target: 12347, 12342
{
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		}
	],
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": null,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "*****",
			"credentialId": 74952,
			"isExpression": false
		}
	]
}

When we run a PUT request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

And the PUT request receives the following JSON target object,

Target: 12347, 12342
{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223]
		},
		{
			"endPointId": 10111,
			"resourceIds": []
		}
	],
	"environmentId": 12347,
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "classpath",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.newcompany.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "newPass",
			"credentialId": null,
			"isExpression": false
		}
	]
}

The PUT request would then update the target with the environment 12347 and the instance 12342. It will return the following JSON object:

Environment Instance: 12347, 12342
{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223]
		},
		{
			"endPointId": 10111,
			"resourceIds": []
		}
	],
	"environmentId": 12347,
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "classpath",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.newcompany.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "*****",
			"credentialId": 74952,
			"isExpression": false
		}
	]
}

PATCH

This PATCH service will update an existing target with the information passed through a JSON object. If an attribute of the JSON is null it will not be updated in the target.

API URL

http://host:port/flexdeploy/rest/v1/topology/environmentinstance/{environmentId}/{instanceId}

End Points and Resource Types

In PATCH, end points and resource types are added, not replaced

Request

Parameter

Type

Required

Description

environmentId

URLYesURL parameter for the environment Id which is used to find and return an target.
instanceIdURLYesURL parameter for the instance Id which is used to find and return an target.
environmentIdLongNoThe environment id of the target. This parameter is ignored in PATCH.
instanceIdLongNoThe instance id of the target. This parameter is ignore in PATCH.
isActiveBooleanNoWhether or not the target is active
endPointsList<EndPoint>No

List of endpoint ids and their associated resource type ids. If provided endpoint is not associated with target, then it will be mapped. Similarly resource types are associated if not already associated to specific endpoint. If already mapped endpoint is  not in input list then it will not be removed.

EndPoint contains endpointId and array of resourceIds.

propertiesList<Property>No

List of property names, their values, and credential id for encrypted properties. Only values provided in input are updated, other values will not change.

PropertyValue contains propertyName, propertyValue, and credentialId.

Response

AttributesTypeDescription
environmentIdLongThe environment id of the target.
instanceIdLongThe instance id of the target.
isActiveBooleanWhether or not the target is active
endPointsList<EndPoint>List of endpoint ids and their associated resource type ids
propertiesList<PropertyValue>List of property names and their values

Endpoint, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
endPointIdLongEndpoint id mapped to target.
resourceTypeIdsList<Long>List of resource type id for endpoint mapping.
endPointNameString Name of the endpoint.
resourceNamesList<String>List of resources.

Property value, relative to Environment Instance is defined as shown below.

AttributesTypeDescription
propertyNameStringProperty code
propertyValueStringProperty value
credentialIdLongId for the credential associated with property. Applicable only for encrypted properties
isExpressionBooleanIs the propertyValue a groovy expression?

Response Codes

HTTP CodeDescription
200Target was found and patched
401Authentication failure
403Authorization failure (no access to resource)
404Target not found
500Unexpected internal server error

Example

If we had a target in our database with an environment id of 12347 and an instance id of 12342 with the following attributes,

Target: 12347, 12342
{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		}
	],
	"environmentId": 12347,
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": null,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "*****",
			"credentialId": 74952,
			"isExpression": false
		}
	]
}

When we run a PATCH request at the following URL: http://host:port/flexdeploy/rest/v1/topology/environmentinstance/12347/12342

And the PATCH request receives the following JSON etarget object,

Target: 12347, 12342
{
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [12123]
		},
		{
			"endPointId": 12241,
			"resourceIds": [18612]
		}
	],
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "new value",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "",
			"credentialId": 52268,
			"isExpression": false
		}
	]
}

The PATCH request would then update the environment instance with the environment 12347 and the instance 12342. It will return the following JSON object:

Target: 12347, 12342
{
	"instanceId": 12342,
	"endPoints":
	[
		{
			"endPointId": 10101,
			"resourceIds": [11223,11224,12123]
		},
		{
			"endPointId": 10111,
			"resourceIds": [11223]
		},
		{
			"endPointId": 12241,
			"resourceIds": [18612]
		}
	],
	"environmentId": 12347,
	"isActive": true,
	"properties":
	[
		{
			"propertyName": "FDSOA_EXT_CLASSPATH",
			"propertyValue": "new value",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_REVISIONS_TO_KEEP",
			"propertyValue": 15,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_HOST",
			"propertyValue": "dev-soa.company.local",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FDSOA_SERVER_PORT",
			"propertyValue": 8001,
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "FD_ORACLE_SOA_HOME",
			"propertyValue": "/u01/oracle/products/fmw/soa",
			"credentialId": null,
			"isExpression": false
		},
		{
			"propertyName": "MDS_PASS",
			"propertyValue": "*****",
			"credentialId": 52268,
			"isExpression": false
		}
	]
}
The following macros are not currently supported in the footer:
  • style