Set Custom Form
Set blueprint to use custom form.
Request
URI
POST
https://{api_host}/composition-service/api/blueprints/{blueprintId}/forms/{formType}
COPY
Path Parameters
string
blueprintId
Required
The objectId of the blueprint.
string
formType
Required
The type of the form.
Request Body
The json string containing the custom form.
string
of type(s)
application/json
Required
Responses
200
Success - the custom form is set.
Returns
RestEntity
of type(s)
*/*
{
"setLocation": false,
"httpStatus": "string"
}
boolean
setLocation
Optional
setLocation
string
httpStatus
Optional
httpStatus
Possible values are :
CONTINUE,
SWITCHING_PROTOCOLS,
PROCESSING,
CHECKPOINT,
OK,
CREATED,
ACCEPTED,
NON_AUTHORITATIVE_INFORMATION,
NO_CONTENT,
RESET_CONTENT,
PARTIAL_CONTENT,
MULTI_STATUS,
ALREADY_REPORTED,
IM_USED,
MULTIPLE_CHOICES,
MOVED_PERMANENTLY,
FOUND,
MOVED_TEMPORARILY,
SEE_OTHER,
NOT_MODIFIED,
USE_PROXY,
TEMPORARY_REDIRECT,
PERMANENT_REDIRECT,
BAD_REQUEST,
UNAUTHORIZED,
PAYMENT_REQUIRED,
FORBIDDEN,
NOT_FOUND,
METHOD_NOT_ALLOWED,
NOT_ACCEPTABLE,
PROXY_AUTHENTICATION_REQUIRED,
REQUEST_TIMEOUT,
CONFLICT,
GONE,
LENGTH_REQUIRED,
PRECONDITION_FAILED,
PAYLOAD_TOO_LARGE,
REQUEST_ENTITY_TOO_LARGE,
URI_TOO_LONG,
REQUEST_URI_TOO_LONG,
UNSUPPORTED_MEDIA_TYPE,
REQUESTED_RANGE_NOT_SATISFIABLE,
EXPECTATION_FAILED,
I_AM_A_TEAPOT,
INSUFFICIENT_SPACE_ON_RESOURCE,
METHOD_FAILURE,
DESTINATION_LOCKED,
UNPROCESSABLE_ENTITY,
LOCKED,
FAILED_DEPENDENCY,
UPGRADE_REQUIRED,
PRECONDITION_REQUIRED,
TOO_MANY_REQUESTS,
REQUEST_HEADER_FIELDS_TOO_LARGE,
INTERNAL_SERVER_ERROR,
NOT_IMPLEMENTED,
BAD_GATEWAY,
SERVICE_UNAVAILABLE,
GATEWAY_TIMEOUT,
HTTP_VERSION_NOT_SUPPORTED,
VARIANT_ALSO_NEGOTIATES,
INSUFFICIENT_STORAGE,
LOOP_DETECTED,
BANDWIDTH_LIMIT_EXCEEDED,
NOT_EXTENDED,
NETWORK_AUTHENTICATION_REQUIRED,
object
httpHeaders
Optional
httpHeaders
object
body
Optional
body
400
Invalid request - bad data.
Operation doesn't return any data structure
403
Forbidden.
Operation doesn't return any data structure
404
Blueprint not found.
Operation doesn't return any data structure