{ "opencollection": "1.0.0", "info": { "name": "Fixxbook.Bearer.Api.V1 AfterHours Attachments API", "version": "bearer.v1" }, "items": [ { "info": { "name": "Attachments", "type": "folder" }, "items": [ { "info": { "name": "Add Attachments to Work Order Note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workorders/:workorderId/notes/:noteId/attachments", "params": [ { "name": "workorderId", "value": "", "type": "path", "description": "Numeric Id of the Work order to perform action with." }, { "name": "noteId", "value": "", "type": "path", "description": "Numeric Id of the Note to perform action with." } ] }, "docs": "Add Attachments to Work Order Note. Returns list of attachments Id for successful request." }, { "info": { "name": "Add attchment to RFP", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rfps/:id/attachments", "params": [ { "name": "id", "value": "", "type": "path", "description": "Rfp ID to perform action with." } ] }, "docs": "Adds attchment to RFP. Returns RFP attachment Id for successful request." }, { "info": { "name": "Returns list of attachment ids and urls.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/siteaudit/comments/:commentId/attachments", "params": [ { "name": "commentId", "value": "", "type": "path", "description": "Numeric Id of the Comment which Attachment belongs to." } ] }, "docs": "Returns list of attachment ids and urls." }, { "info": { "name": "Add attchment to Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/siteaudit/comments/:commentId/attachments", "params": [ { "name": "commentId", "value": "", "type": "path", "description": "Numeric Id of the Comment to perform action with." } ] }, "docs": "Adds attchment to Comment. If Comment is not created yet specify {commentId} = -1." }, { "info": { "name": "Retrieve original attchment from Comment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/siteaudit/comments/:commentId/attachments/:attachmentId", "params": [ { "name": "commentId", "value": "", "type": "path", "description": "Numeric Id of the Comment which Attachment belongs to." }, { "name": "attachmentId", "value": "", "type": "path", "description": "Numeric Id of the Attachment to perform action with." } ] }, "docs": "Retrieve original attchment from Comment" }, { "info": { "name": "Retrieve resized attchment from Comment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/siteaudit/comments/:commentId/attachments/:attachmentId/thumbnail", "params": [ { "name": "commentId", "value": "", "type": "path", "description": "Numeric Id of the Comment which Attachment belongs to." }, { "name": "attachmentId", "value": "", "type": "path", "description": "Numeric Id of the Attachment to perform action with." }, { "name": "width", "value": "", "type": "query", "description": "Width of the output file." }, { "name": "height", "value": "", "type": "query", "description": "Height of the output file." }, { "name": "mode", "value": "", "type": "query", "description": "How to resolve aspect ratio differences between the requested size and the \r\n original image's size: Max = 1, Pad = 2, Crop = 3, Carve = 4, Stretch = 5." }, { "name": "imageFormat", "value": "", "type": "query", "description": "The desired image format, like 'jpg', 'gif', or 'png'. Do not specify \r\n if you want to preserve the original format." } ] }, "docs": "Retrieve resized attchment from Comment" }, { "info": { "name": "Get Asset Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/assets/:assetId/attachments", "params": [ { "name": "assetId", "value": "", "type": "path", "description": "Asset Identifier" }, { "name": "providerId", "value": "", "type": "query", "description": "The provider identifier. Required for sub-contractor request. [Required Special permissions]" } ] }, "docs": "Get Asset Attachments" }, { "info": { "name": "Add Attachments to Asset", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assets/:assetId/attachments", "params": [ { "name": "assetId", "value": "", "type": "path" }, { "name": "isDefault", "value": "", "type": "query" } ] }, "docs": "Add Attachments to Asset" }, { "info": { "name": "Delete Asset Attachment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assets/:assetAttachmentId/deleteAttachment", "params": [ { "name": "assetAttachmentId", "value": "", "type": "path" } ] }, "docs": "Delete Asset Attachment" }, { "info": { "name": "Get Asset Attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assets/getattachmentsbyassetids" }, "docs": "Get Asset Attachments" }, { "info": { "name": "Get Asset Attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/assets/getattachmentsbyassetids_v1" }, "docs": "Get Asset Attachments" }, { "info": { "name": "Update asset attachment by id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/assets/updateAssetAttachment", "params": [ { "name": "attachmentId", "value": "", "type": "query", "description": "Attachment identifier" }, { "name": "fileName", "value": "", "type": "query", "description": "New file name" }, { "name": "description", "value": "", "type": "query", "description": "New file description(comment)" } ] }, "docs": "Update asset attachment by id" }, { "info": { "name": "Get WorkRequest Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workrequest/:workRequestId/attachments", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "WorkRequest Identifier" } ] }, "docs": "*In limited availability phase.*" }, { "info": { "name": "Add attachments to a WorkRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workrequest/:workRequestId/attachments", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "Numeric ID of the WorkRequest to add attachments to." }, { "name": "actor", "value": "", "type": "query", "description": "Name of the person on whose behalf you are performing the action" } ] }, "docs": "*In limited availability phase.*\r\n
Adds attachments to the specified WorkRequest." }, { "info": { "name": "Add Attachments to Work Request Note", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workrequest/:workRequestId/notes/:noteId/attachments", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "Numeric Id of the Work Request to perform action with." }, { "name": "noteId", "value": "", "type": "path", "description": "Numeric Id of the Note to perform action with." } ] }, "docs": "*In limited availability phase.*\r\n
Add Attachments to Work Request Note. Returns list of attachments Id for successful request." }, { "info": { "name": "Get WorkRequest Note Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workrequest(:workRequestId)/notes(:noteId)/attachments", "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "WorkRequest Identifier" }, { "name": "noteId", "value": "", "type": "path", "description": "Note Identifier" } ] }, "docs": "*In limited availability phase.*" }, { "info": { "name": "Upload Attachments To Storage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/refrigeranttracking/uploadplanattachmentsonblob" }, "docs": "Upload Attachments To Storage" }, { "info": { "name": "Get retrofit retire plan attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/refrigeranttracking/RetrofitRetirePlanAttachments", "params": [ { "name": "planId", "value": "", "type": "query", "description": "Request" } ] }, "docs": "Returns list of attachments for the specific plan." }, { "info": { "name": "Add file link to the specific retrofit retire plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/refrigeranttracking/linkPlanAttachments" }, "docs": "Add file link to the specific retrofit retire plan" }, { "info": { "name": "Delete retrofit retire plan attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/refrigeranttracking/removeattachments" }, "docs": "Delete retrofit retire plan attachments" }, { "info": { "name": "Add attachments to a work order", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workorders/:workorderId/attachments", "params": [ { "name": "workorderId", "value": "", "type": "path", "description": "Numeric ID of the work order to add attachments to.\r\n You can upload a file without binding it to a Work Order. To do this, you need to set -1 instead of WorkOrderId. \r\n In the response, you will receive Path for further uploading of the file from Remote Storage." }, { "name": "actor", "value": "", "type": "query" } ] }, "docs": "Adds attachments to the specified work order." }, { "info": { "name": "Add attachments to a work order by PO number. Only for Subscriber.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workorders/:poNumber/attachmentsByPoNumber", "params": [ { "name": "poNumber", "value": "", "type": "path", "description": "Purchase Order" }, { "name": "actor", "value": "", "type": "query", "description": "On whose behalf the attachment is adding" } ] }, "docs": "Add attachments to a work order by PO number. Only for Subscriber." }, { "info": { "name": "POSTv3_workorders_attachmentAsBase64", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workorders/attachmentAsBase64" } }, { "info": { "name": "GETv3_workorders_{workorderId}_attachments_{attachmentId}_thumbnail?width={width}&height={height}&mode={mode}&imageFormat={imageFormat}", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workorders/:workorderId/attachments/:attachmentId/thumbnail", "params": [ { "name": "workorderId", "value": "", "type": "path" }, { "name": "attachmentId", "value": "", "type": "path" }, { "name": "width", "value": "", "type": "query" }, { "name": "height", "value": "", "type": "query" }, { "name": "mode", "value": "", "type": "query" }, { "name": "imageFormat", "value": "", "type": "query" } ] } }, { "info": { "name": "Delete a work order attachment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workorders/:workOrderId/attachments/:attachmentId", "params": [ { "name": "workOrderId", "value": "", "type": "path", "description": "Unique numeric identifier of the work order." }, { "name": "attachmentId", "value": "", "type": "path", "description": "Unique numeric identifier of the attachment to be removed from the work order.\r\n
To get the attachment ID, use the [GET /odata/workorders({workorderId})/attachments](https://developer.servicechannel.com/swagger/index.html#/Attachments/Attachments_GetWorkOrderAttachments)." } ] }, "docs": "Removes an attachment from the specified work order. Returns the work order ID in the response. Removing an attachment from the work order using this method creates a system note for this work order. \r\n
This method is available for subscribers and providers.\r\n
***Note***: Deleting an attachment from the work order doesn’t remove this attachment from the ServiceChannel database." }, { "info": { "name": "Get a work order attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/workorders(:workorderId)/attachments", "params": [ { "name": "workorderId", "value": "", "type": "path", "description": "Unique numeric identifier of the work order." }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieves attachment(s) added to the specified work order." }, { "info": { "name": "Get a work order note attachment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/workorders(:workorderId)/notes(:noteId)/attachments", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Unique numeric identifier of the note." }, { "name": "workorderId", "value": "", "type": "path", "description": "Unique numeric identifier of the work order." }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieves attachments added to the note of the specified work order." }, { "info": { "name": "Retrieve Attachment Thumbnail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/workorders(:workorderId)/attachments(:attachmentId)/Service.GetThumbnail(width=:width,height=:height,mode=:mode,imageFormat=:imageFormat)", "params": [ { "name": "imageFormat", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "path" }, { "name": "height", "value": "", "type": "path" }, { "name": "width", "value": "", "type": "path" }, { "name": "attachmentId", "value": "", "type": "path", "description": "Attachment Identifier" }, { "name": "workorderId", "value": "", "type": "path", "description": "Workorder Identifier" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieve Attachment Thumbnail" }, { "info": { "name": "Retrieve Proposal Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/proposals(:proposalId)/attachments", "params": [ { "name": "proposalId", "value": "", "type": "path", "description": "Proposal Identifier" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieve Proposal Attachments" }, { "info": { "name": "Retrieve Attachment Thumbnail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/proposals(:proposalId)/attachments(:attachmentId)/Service.GetThumbnail(width=:width,height=:height,mode=:mode,imageFormat=:imageFormat)", "params": [ { "name": "imageFormat", "value": "", "type": "path" }, { "name": "mode", "value": "", "type": "path" }, { "name": "height", "value": "", "type": "path" }, { "name": "width", "value": "", "type": "path" }, { "name": "attachmentId", "value": "", "type": "path", "description": "Attachment Identifier" }, { "name": "proposalId", "value": "", "type": "path", "description": "Proposal Identifier" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieve Attachment Thumbnail" }, { "info": { "name": "Retrieve Rfp Attachments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/odata/rfps(:rfpId)/attachments", "params": [ { "name": "rfpId", "value": "", "type": "path", "description": "Rfp Identifier" }, { "name": "$expand", "value": "", "type": "query", "description": "Expand a navigation property." }, { "name": "$select", "value": "", "type": "query", "description": "Select a set of properties to return." }, { "name": "$filter", "value": "", "type": "query", "description": "Filter a collection of resources addressed by a request URL." }, { "name": "$orderby", "value": "", "type": "query", "description": "Order resources by the specified property in the response." }, { "name": "$top", "value": "", "type": "query", "description": "Return the specified number of items in the response." }, { "name": "$skip", "value": "", "type": "query", "description": "Skip the specified number of items in the response." }, { "name": "$count", "value": "", "type": "query", "description": "Include the count of the matching resources in the response." } ] }, "docs": "Retrieve Rfp Attachments" } ] } ], "bundled": true }