Jump to

• Request
• Response
• Examples

Delete a file property

delete

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

This operation deletes 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.

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

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' -X DELETE '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