Jump to

• Request
• Response

Upload a document

post

/hcmRestApi/resources/11.13.18.05/recruitingCEDocumentDrafts/action/uploadDocument

Uploads a document and creates a recruiting CE document draft.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• Action: string
  Operation for the document upload.
• Attachment: string
  Attachment details for the uploaded file.
• Category: string
  Document category for the upload.
• FileContents: string
  Base64-encoded file contents for the upload.
• FileSource: string
  Source of the file content for the upload.
• Type: string
  Document type for the upload.

{
    "type":"object",
    "properties":{
        "Action":{
            "type":"string",
            "description":"Operation for the document upload.",
            "nullable":true
        },
        "Type":{
            "type":"string",
            "description":"Document type for the upload.",
            "nullable":true
        },
        "Category":{
            "type":"string",
            "description":"Document category for the upload.",
            "nullable":true
        },
        "FileContents":{
            "type":"string",
            "description":"Base64-encoded file contents for the upload.",
            "nullable":true
        },
        "FileSource":{
            "type":"string",
            "description":"Source of the file content for the upload.",
            "nullable":true
        },
        "Attachment":{
            "type":"string",
            "description":"Attachment details for the uploaded file.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Uploaded document draft details returned by the action.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Uploaded document draft details returned by the action."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Uploaded document draft details returned by the action."
}

Uploaded document draft details returned by the action.

Back to Top