Jump to

• Request
• Response

Get Root Directory of File System

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/filesystem/root

Get the root directory metadata

Request

Query Parameters

• filterPattern(required): string
  File name pattern
• listFiles: boolean
  Flag to indicate whether to include files in the list

  Default Value: true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : filesystem

Type: object

Read Only: true

Provides metadata for a specified folder and its child folders/files

Show Source

• createDate: string
  Read Only: true
• directories: array directories
  Read Only: true

  List of child folders
• files: array files
  Read Only: true

  List of child files
• guid: string
  Read Only: true

  Path id
• links: array links
• path(required): string
  Read Only: true

  Directory Path

{
    "required":[
        "path"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "description":"Path id",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
            }
        },
        "path":{
            "type":"string",
            "description":"Directory Path",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
            }
        },
        "createDate":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
            }
        },
        "directories":{
            "type":"array",
            "description":"List of child folders",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
            },
            "items":{
                "$ref":"#/components/schemas/Directory"
            }
        },
        "files":{
            "type":"array",
            "description":"List of child files",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            },
            "items":{
                "$ref":"#/components/schemas/File"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
            },
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"Provides metadata for a specified folder and its child folders/files",
    "readOnly":true,
    "xml":{
        "name":"filesystem",
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
    }
}

Nested Schema : directories

Type: array

Read Only: true

List of child folders

Show Source

• Array of: object schema

{
    "type":"array",
    "description":"List of child folders",
    "readOnly":true,
    "xml":{
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
    },
    "items":{
        "$ref":"#/components/schemas/Directory"
    }
}

Nested Schema : files

Type: array

Read Only: true

List of child files

Show Source

• Array of: object files
  Read Only: true

  List of child files

{
    "type":"array",
    "description":"List of child files",
    "readOnly":true,
    "xml":{
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
    },
    "items":{
        "$ref":"#/components/schemas/File"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem"
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : schema

Type: object

Show Source

• createdDate: string
  Read Only: true
• links: array links
• name(required): string
  Read Only: true

  Name of the folder
• parent(required): string
  Read Only: true

  Parent folder path

{
    "required":[
        "name",
        "parent"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the folder",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
            }
        },
        "parent":{
            "type":"string",
            "description":"Parent folder path",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
            }
        },
        "createdDate":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
            },
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "xml":{
        "name":"directories",
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/directory"
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(required): string
• rel(required): string

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

Nested Schema : files

Type: object

Read Only: true

List of child files

Show Source

• createdDate: string
  Read Only: true
• lastModifiedDate: string
  Read Only: true
• links: array links
• name(required): string
  Read Only: true
• parent(required): string
  Read Only: true
• size: string
  Read Only: true

{
    "required":[
        "name",
        "parent"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            }
        },
        "parent":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            }
        },
        "createdDate":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            }
        },
        "lastModifiedDate":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            }
        },
        "size":{
            "type":"string",
            "readOnly":true,
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            }
        },
        "links":{
            "type":"array",
            "xml":{
                "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
            },
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    },
    "description":"List of child files",
    "readOnly":true,
    "xml":{
        "name":"files",
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "namespace":"http://xmlns.oracle.com/cloud/fileserver/filesystem/file"
    },
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

401 Response

Unauthorized

404 Response

Service not found

500 Response

Internal Server Error

Back to Top