Jump to

• Request
• Response
• Examples

Get a file property

get

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

This operation retrieves the file property for the specified resource.

Request

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

• Accept: string

  The request must contain the Accept header to retrieve the file contents. The header must have either of the following:

  • The actual content type (for example, application/pdf for pdf documents).
  • The special value 'application/octet-stream', when you don't know the content type.

  If the request doesn't have the Accept header, the response contains only the file metadata in JSON format.

Back to Top

Response

Supported Media Types

• application/octet-stream

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : File

Type: string(binary)

Title: File

The contents of the file. This is usually binary data.

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 get a file property of a resource by submitting a GET request on the REST resource using cURL.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -H 'Accept: application/octet-stream' 'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/resources/john.smith/uploadedPic' > filename.jpeg

Example of Response

In this example, response is written directly to file.

Back to Top