Update a Boilerplate

PUT {{base_url}}/boilerplate/:Name

Specify the unique identifier for the boilerplate you want to update in the request URL using the Name variable.

Please note that in the JSON request body for the PUT, you cannot update the Name as a fieldname as part of the request data even though the metadata may show that Name is updateable. Name is the primary key and Displayname is the actual name of the boilerplate.

For example, set PUT {{base_url}}/boilerplate/{{Name}} where the Name variable is set with a GUID value. The request URL will override adding anything that has been added as a JSON data key value pair for Name: Text or ID for the boilerplate in the request body.

curl --request PUT \
--url 'https://{{base_url}}/boilerplate/[GUID]' \
--header 'authorization: Bearer {{oauth_token}}' \
--header 'content-type: application/json' \
--data '    {
  "DisplayName": "Test Boilerplate Name",
  "Description": "Lorem ipsum dolor sit amet, zril iudico duo at. Appareat efficiantur definitiones et sit. Vidisse fabulas ut duo, tota dissentiunt duo no, atqui repudiandae vis et. Qui eu vero equidem definiebas, hinc detracto luptatum vix ex, ei fierent moderatius refor",
  "CustomCurrencyCode": "USD"
}'

Request Params

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. |

HEADERS

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

[{"Name":"Creating Boilerplate Name to Delete via API","Description":"Testing the POST boilerplate creation endpoint.","Document":"\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eApple \u0026amp; Bartlett was founded in 1965 and is one of the premier full-service firms.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eOur areas of expertise include award-winning projects in the areas of health-care, commercial development, retail, laboratories, wastewater treatment, roads, bridges, schools, industrial parks, laboratories, gardens, master planning.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u0026nbsp;\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eApple \u0026amp; Bartlett LLC employees cost control techniques, allowing managers to establish an accurate project budget, and design to this budget as evidenced by the low bid amount found in most of the firm\u0026#39;s projects.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eTo manage our project budgets, we have developed an internal method of cost modeling.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eOnce the client\u0026#39;s project program is finalized and the conceptual design is approved, we prepare a cost model package broadly outlining each phase and aspect of the project.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eThis cost model yields a pricing package which forms the basis for the discussion of the project budget with the client.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eAt the conclusion of the cost-modeling process, a project budget is established. The project budget is continually reviewed at each phase of the project development to ensure accuracy in accordance with the cost model.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eThe identification of land-use patterns will provide insights into the future development of the complex.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eExisting open-space, pedestrian and vehicular movement patterns and service locations, will be analyzed with regard to total campus development.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eApple \u0026amp; Bartlett LLC employees cost control techniques, allowing managers to establish an accurate project budget, and design to this budget as evidenced by the low bid amount found in most of the firm\u0026#39;s projects.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp class=\"MsoNormal\"\u003e\u003cspan style=\"font-family:Arial; font-size:medium\"\u003eTo manage our project budgets, we have developed an internal method of cost modeling.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eOnce the client\u0026#39;s project program is finalized and the conceptual design is approved, we prepare a cost model package broadly outlining each phase and aspect of the project.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eThis cost model yields a pricing package which forms the basis for the discussion of the project budget with the client.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eAt the conclusion of the cost-modeling process, a project budget is established. The project budget is continually reviewed at each phase of the project development to ensure accuracy in accordance with the cost model.\u003c/span\u003e\u003c/p\u003e\n\n\u003cp\u003e\u003cspan style=\"font-family:'Times New Roman'; font-size:12pt; mso-ansi-language:EN-US; mso-bidi-language:AR-SA; mso-fareast-font-family:'Times New Roman'; mso-fareast-language:EN-US\"\u003e\u003cspan style=\"font-family:Arial\"\u003eThe identification of land-use patterns will provide insights into the future development of the complex.\u003cspan style=\"mso-spacerun:yes\"\u003e\u0026nbsp; \u003c/span\u003eExisting open-space, pedestrian and vehicular movement patterns and service locations, will be analyzed with regard to total campus development.\u003c/span\u003e \u003c/span\u003e\u003c/p\u003e","CustomCurrencyCode":"USD","DisplayName":"Test Boilerplate Name","CreateUser":"Brenda Gray, PE","CreateDate":"2018-01-24T22:32:25.400","ModUser":"Brenda Gray, PE","ModDate":"2018-03-27T17:19:08.917","CustName":"","CustProject":"","desc_CustProject":"","CustResponsibleContact":"","desc_CustResponsibleContact":"","CustNote":"","CustResponsible":"","desc_CustResponsible":"","CustFollowup":"N","CustomTest":0}]