Jump to

• Request
• Response
• Examples

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

• application/octet-stream

Path Parameters

• propertyLabel(required): string
  The label of a custom property. This custom property must be of type 'file'.
• resourceId(required): string
  The unique identifier of the resource in Oracle Field Service. 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

• Content-Disposition: string
  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'.
• Content-Type: string
  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 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

• application/json
• application/schema+json

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

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

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>.fs.ocs.oraclecloud.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