REST API for Oracle Field Service Cloud Service

Get daily extract dates

get

/rest/ofscCore/v1/folders/dailyExtract/folders

This operation retrieves a list of dates where a daily extract file is available.

Note: The daily extract files are deleted after 90 days.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

This section describes the 200 status response for this operation.

Root Schema : Daily Extract Subfolders

Type: object

Title: Daily Extract Subfolders

The list of subfolders with daily extract files. Each subfolder is named in the 'YYYY-MM-DD' format.

Show Source

items: array Items

Title: Items

The list of subfolders with daily extract files.

{
    "title":"Daily Extract Subfolders",
    "description":"The list of subfolders with daily extract files. Each subfolder is named in the 'YYYY-MM-DD' format.",
    "type":"object",
    "properties":{
        "items":{
            "items":{
                "type":"object",
                "title":"Folder",
                "description":"The folder that has the daily extract files.",
                "properties":{
                    "name":{
                        "type":"string",
                        "title":"Name",
                        "description":"The name of the folder."
                    },
                    "links":{
                        "title":"Links",
                        "description":"The links to access the subfolders.",
                        "type":"array",
                        "items":{
                            "properties":{
                                "rel":{
                                    "type":"string"
                                },
                                "href":{
                                    "type":"string"
                                },
                                "mediaType":{
                                    "type":"string"
                                }
                            },
                            "required":[
                                "rel",
                                "href"
                            ]
                        }
                    }
                }
            },
            "type":"array",
            "description":"The list of subfolders with daily extract files. ",
            "title":"Items"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The list of subfolders with daily extract files.

Show Source

Array of: object Folder

Title: Folder

The folder that has the daily extract files.

{
    "items":{
        "type":"object",
        "title":"Folder",
        "description":"The folder that has the daily extract files.",
        "properties":{
            "name":{
                "type":"string",
                "title":"Name",
                "description":"The name of the folder."
            },
            "links":{
                "title":"Links",
                "description":"The links to access the subfolders.",
                "type":"array",
                "items":{
                    "properties":{
                        "rel":{
                            "type":"string"
                        },
                        "href":{
                            "type":"string"
                        },
                        "mediaType":{
                            "type":"string"
                        }
                    },
                    "required":[
                        "rel",
                        "href"
                    ]
                }
            }
        }
    },
    "type":"array",
    "description":"The list of subfolders with daily extract files. ",
    "title":"Items"
}

Nested Schema : Folder

Type: object

Title: Folder

The folder that has the daily extract files.

Show Source

links: array Links

Title: Links

The links to access the subfolders.
name: string

Title: Name

The name of the folder.

{
    "type":"object",
    "title":"Folder",
    "description":"The folder that has the daily extract files.",
    "properties":{
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the folder."
        },
        "links":{
            "title":"Links",
            "description":"The links to access the subfolders.",
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    },
                    "mediaType":{
                        "type":"string"
                    }
                },
                "required":[
                    "rel",
                    "href"
                ]
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The links to access the subfolders.

Show Source

Array of: object items

{
    "title":"Links",
    "description":"The links to access the subfolders.",
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            },
            "mediaType":{
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

href(required): string
mediaType: string
rel(required): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Default Response

This section describes the default error response for this operation.

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"
    ]
}

Examples

The following example shows how to get daily extract dates by submitting a GET request on the REST resource using cURL.

curl -u '<CLIENT-ID>@<INSTANCE-NAME>:<CLIENT-SECRET>' \
     -H 'Accept: application/json' \
     'https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/folders/dailyExtract/folders'

Example of Request Header

The following shows an example of the resquest header.

GET /rest/ofscCore/v1/folders/dailyExtract/folders HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: Basic c29hcEB0ZXN0YXBpY29yZS5pbjQwMDox
Host: <instance_name>.fs.ocs.oraclecloud.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Server: nginx/1.6.2
Date: Wed, 15 Jul 2015 12:30:56 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
   "name": "folders",
   "folders":
     {
      "items":
         [
           {
             "name": "2015-07-01",
             "links": [
                        {
                            "rel": "canonical",
                            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/folders/dailyExtract/folders/2015-07-01"
                        }
                      ]
            },
                {
                   "name": "2015-07-02",
                   "links": [
                        {
                            "rel": "canonical",
                            "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/folders/dailyExtract/folders/2015-07-02"
                        }
                            ]
                }
          ],
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/folders/dailyExtract/folders"
                }
                     ]
        },
        "links": [
            {
                "rel": "canonical",
                "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/folders/dailyExtract/folders"
            },
            {
                "rel": "describedby",
                "href": "https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscCore/v1/metadata-catalog/folders"
            }
                 ]
}