/workorder/{workOrderId}/revise v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Base URLs:
Work Orders
postWorkOrderIdRevise
Code samples
const inputBody = '{
"type": "object",
"properties": {
"params": {
"type": "object",
"properties": {
"revision": {
"type": "string",
"description": "New revision level",
"example": "Rev 2"
}
}
}
},
"required": [
"revision"
]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization':{
"type": "string"
}
};
fetch('https://goldleaf.app/api/v1/workorder/{workOrderId}/revise',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
POST /workorder/{workOrderId}/revise
Revises the specified work order by creating a new version with an updated revision level
Body parameter
{
"type": "object",
"properties": {
"params": {
"type": "object",
"properties": {
"revision": {
"type": "string",
"description": "New revision level",
"example": "Rev 2"
}
}
}
},
"required": ["revision"]
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token for authorization |
| workOrderId | path | string | true | Work order ID to revise (MongoDB ObjectId) |
| body | body | object | true | Revision details |
| » params | body | object | false | none |
| »» revision | body | string | false | New revision level |
Example responses
500 Response
{
"type": "string"
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Work order revised successfully | None |
| 500 | Internal Server Error | none | string |
