Set a file property

put

/rest/ofscCore/v1/resources/{resourceId}/{propertyLabel}

This operation creates the specified 'file' property for the specified resource.

Note: The maximum size of the file that can be uploaded is 5 MB.

Request

Supported Media Types
Path Parameters
  • The label of a custom property. This custom property must be of type 'file'.
  • The unique identifier of the resource in Oracle Field Service Cloud. This maps to the resource field 'external_id' and is not necessarily set for all resources. The resources without this parameter are not visible to the operation.
Header Parameters
  • The custom filename for the property. For example, Content-Disposition: attachment; filename="photo-of-the-door.jpg" sets the filename for the property to 'photo-of-the-door.jpg'.
  • The media type of the property. For file properties of type 'image' having content-type as 'image/png', 'image/jpeg', or 'image/gif', Oracle Field Service Cloud generates a preview thumbnail that appears in Manage/Mobility.
Body ()
Root Schema : File
Type: string(binary)
Title: File
The contents of the file. This is usually binary data.
Back to Top

Response

Supported Media Types

204 Response

This section describes the 204 status response for this operation. This response code indicates that the operation completed successfully. This operation does not return elements in the response body.

Default Response

This section describes the default error response for this operation.
Body ()
Root Schema : Error
Type: object
Error response
Show Source
Back to Top

Examples

The following example shows how to set a file property of a resource by submitting a PUT request on the REST resource using cURL.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -X PUT --data-binary @filename.jpeg 'https://<instance_name>.etadirect.com/rest/ofscCore/v1/resources/john.smith/uploadedPic'

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 204 No Content
Back to Top