Get a file property
get
/rest/ofscCore/v1/inventories/{inventoryId}/{propertyLabel}
This operation retrieves the specified file property for the specified inventory.
Request
Path Parameters
-
inventoryId(required): integer
The unique identifier of the inventory in Oracle Field Service.
-
propertyLabel(required): string
The label of a custom property. This custom property must be of type 'file'.
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.
Response
Supported Media Types
- application/octet-stream
200 Response
This section describes the 200 status response for this operation.
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.
Root Schema : Error
Type:
Show Source
object
-
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.
Examples
The following example shows how to get a file property of an inventory 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/inventories/21258546/uploadedPic' > filename.jpeg
Example of Response
In this example, response is written directly to file.