Jump to

• Request
• Response

Rescan a File

post

/api/restapi/document/file/rescan

Send a request to this endpoint to rescan a file. Only the files with scanStatus as SCAN_ERROR can be rescanned.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityRescanRequest

Type: object

Title: ApiEntityRescanRequest

This entity represents a RescanRequest object, a unique RescanRequest object can be identified by the following combinations of the fields.

• id
• parentId, name
• parentFolderPath, name, scope, workspaceId
• parentFolderPath, name, scope, workspaceCode

Show Source

• id(required): string
  Maximum Length: 18

  The system-generated identifier of the file, folder, or template.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• name: string
  Maximum Length: 255

  The name of the file, folder, or template.
• parentFolderPath: string
  Maximum Length: 18

  The path of the parent folder from it's root folder.
  The field is non-persistable and thus maximum length is not applicable.
• parentId: string
  Maximum Length: 18

  The system-generated identifier of the parent object of the file or folder.
• scope: string
  Allowed Values: [ "genericPortfolio", "project", "template", "idea", "program", "strategy" ]

  The object name of the context the file or folder is created in.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• version: string
  Maximum Length: 255

  The version of the file to be rescanned.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The system-specified identifier of a workspace.

{
    "title":"ApiEntityRescanRequest",
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the file, folder, or template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the file, folder, or template.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "version":{
            "maxLength":"255",
            "type":"string",
            "description":"The version of the file to be rescanned.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name of the context the file or folder is created in.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "genericPortfolio",
                "project",
                "template",
                "idea",
                "program",
                "strategy"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-specified identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the parent object of the file or folder.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentFolderPath":{
            "maxLength":"18",
            "type":"string",
            "description":"The path of the parent folder from it's root folder.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a RescanRequest object, a unique RescanRequest object can be identified by the following combinations of the fields.<ul><li>id</li><li>parentId, name</li><li>parentFolderPath, name, scope, workspaceId</li><li>parentFolderPath, name, scope, workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Rescan a file

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityRescanResponse

Type: object

Title: ApiEntityRescanResponse

This entity represents a RescanResponse object, a unique RescanResponse object can be identified by the following combinations of the fields.

• id
• parentId, name
• parentFolderPath, name, scope, workspaceId
• parentFolderPath, name, scope, workspaceCode

Show Source

• id: string
  Read Only: true

  Maximum Length: 18

  The system-generated identifier of the file, folder, or template.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• message: string
  Read Only: true

  The information populated based on result of the rescan operation. The field is non-persistable and thus maximum length is not applicable.
• name: string
  Read Only: true

  Maximum Length: 255

  The name of the file, folder, or template.
• parentFolderPath: string
  Read Only: true

  Maximum Length: 18

  The path of the parent folder from it's root folder.
  The field is non-persistable and thus maximum length is not applicable.
• parentId: string
  Read Only: true

  Maximum Length: 18

  The system-generated identifier of the parent object of the file or folder.
• scanStatus: string
  Read Only: true

  Allowed Values: [ "SCAN_PENDING", "SCAN_CLEARED", "SCAN_FAILED", "SCAN_INCONCLUSIVE", "SCAN_ERROR", "SCAN_DISABLED" ]

  Virus scan status of the version of a file the rescan has been triggered. A virus scan could return one of the following virus statuses:

  • SCAN_FAILED : A virus was found for this file.
  • SCAN_CLEARED : Virus scan was run and found the file to not contain viruses.
  • SCAN_DISABLED : File has not been scanned for viruses because scanning at has been disabled for the data center.
  • SCAN_INCONCLUSIVE :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.
  • SCAN_PENDING : Virus scan is in progress for this file.
  • SCAN_ERROR : There was an error while scanning the file for viruses. Try to scan the file again.
• scope: string
  Read Only: true

  Allowed Values: [ "genericPortfolio", "project", "template", "idea", "program", "strategy" ]

  The object name of the context the file or folder is created in.
• statusCode: integer (int64)
  Read Only: true

  The response code representing the state of the rescan API operation of a specific file.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• version: string
  Read Only: true

  Maximum Length: 255

  The version of the file the rescan has been triggered.
• workspaceCode: string
  Read Only: true

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  Read Only: true

  The system-specified identifier of a workspace.

{
    "title":"ApiEntityRescanResponse",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "name":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the file, folder, or template.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"The information populated based on result of the rescan operation. The field is non-persistable and thus maximum length is not applicable.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "id":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the file, folder, or template.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "version":{
            "maxLength":"255",
            "type":"string",
            "description":"The version of the file the rescan has been triggered.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scope":{
            "type":"string",
            "description":"The object name of the context the file or folder is created in.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "genericPortfolio",
                "project",
                "template",
                "idea",
                "program",
                "strategy"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The system-specified identifier of a workspace.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "maxLength":"18",
            "type":"string",
            "description":"The system-generated identifier of the parent object of the file or folder.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the rescan API operation of a specific file.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scanStatus":{
            "type":"string",
            "description":"Virus scan status of the version of a file the rescan has been triggered. A virus scan could return one of the following virus statuses: <ul><li><b>SCAN_FAILED</b> : A virus was found for this file.</li><li><b>SCAN_CLEARED</b> : Virus scan was run and found the file to not contain viruses.</li><li><b>SCAN_DISABLED</b> : File has not been scanned for viruses because scanning at has been disabled for the data center.</li><li><b>SCAN_INCONCLUSIVE</b> :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.</li><li><b>SCAN_PENDING</b> : Virus scan is in progress for this file.</li><li><b>SCAN_ERROR</b> : There was an error while scanning the file for viruses. Try to scan the file again.</li></ul>",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SCAN_PENDING",
                "SCAN_CLEARED",
                "SCAN_FAILED",
                "SCAN_INCONCLUSIVE",
                "SCAN_ERROR",
                "SCAN_DISABLED"
            ]
        },
        "parentFolderPath":{
            "maxLength":"18",
            "type":"string",
            "description":"The path of the parent folder from it's root folder.<br />The field is non-persistable and thus maximum length is not applicable.",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a RescanResponse object, a unique RescanResponse object can be identified by the following combinations of the fields.<ul><li>id</li><li>parentId, name</li><li>parentFolderPath, name, scope, workspaceId</li><li>parentFolderPath, name, scope, workspaceCode</li>",
    "exampleSetFlag":false
}

400 Response

Invalid input for the Document service. Verify the request contains valid data, then resubmit the request.

Back to Top