Create a Boilerplate
POST {{base_url}}/boilerplate
Use this endpoint to create a new boilerplate in the Boilerplates hub.
The DisplayName field is required in the request body.
Include all other fields with at least the default values in the request body by checking the boilerplate metadata against your instance of Vantagepoint. The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Request
A successful call status of 201 Created returns the JSON representation for the newly created boilerplate.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
Request Body
[{"name"=>"Name", "value"=>"GUID", "datatype"=>"string"}, {"name"=>"DisplayName", "value"=>"{{string}}", "datatype"=>"string"}, {"name"=>"Description", "value"=>"{{string}}", "datatype"=>"string"}, {"name"=>"Document", "value"=>"", "datatype"=>"null"}, {"name"=>"CustomCurrencyCode", "value"=>"{{string}}", "datatype"=>"string"}, {"name"=>"CreateUser", "value"=>"{{string}}", "datatype"=>"string"}, {"name"=>"CreateDate", "value"=>"{{date}}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: Created
[{"Name":"Creating Boilerplate Name","Description":"Testing the POST boilerplate creation endpoint. Added optional and valid information towards happy path testing.","Document":"","CustomCurrencyCode":"USD","DisplayName":"Test Boilerplate Name to Create via API","CreateUser":"Brenda Gray, PE","CreateDate":"2018-03-26T15:07:30.130","ModUser":"Brenda Gray, PE","ModDate":"2018-03-26T15:07:30.130","CustName":"","CustProject":"","desc_CustProject":"","CustResponsibleContact":"","desc_CustResponsibleContact":"","CustNote":"","CustResponsible":"","desc_CustResponsible":"","CustFollowup":"N","CustomTest":0}]