Post
/pm-doc-rest-api/jersey/v1/uploadDoc
Overview
This request creates a new revision of a Project Management (PM) document attachment and links it to a specific project. It uploads a file along with metadata to the PM document REST API. On success, the API returns a 201 Created response.
Endpoint
| Method | URL |
|---|---|
POST |
{{CMIC_BaseUrl}}/pm-doc-rest-api/jersey/v1/uploadDoc |
Headers
| Key | Value | Description |
|---|---|---|
Content-Type |
application/vnd.oracle.adf.resourceitem+json |
Specifies the media type for the ADF resource item |
Request Body
The body is sent as multipart/form-data with the following fields:
fileDetails (text — JSON)
A JSON string containing the document metadata:
| Field | Type | Required | Description |
|---|---|---|---|
PmdId |
string | Yes | Document ID. Leave empty ("") to create a new document. |
PmdObjectType |
string | Yes | Object type code (e.g. "JBCONT" for Job Contract). |
PmdObjectId1 |
string | Yes | Primary object identifier (e.g. company code such as "ZZ"). |
PmdObjectId2 |
string | Yes | Secondary object identifier (e.g. Project Code such as "ROVER12C"). |
PmdObjectId |
string | Yes | Object identifier — Contract Code |
PmdTitle |
string | Yes | Title of the document (e.g. "Test Document"). |
PmdDesc1 |
string | Yes | Primary description of the document. |
PmdDesc2 |
string | Yes | Secondary description, often used for project reference (e.g. "for project 2021DEC04"). |
PmdProjUuid |
string | Yes | UUID of the project to link this document to. |
PmdTypeCode |
string | Yes | Document type code (e.g. "ATTACHMENT"). |
PmdrComment |
string | Yes | Revision comment or label. |
PmdrRcvdDate |
string (YYYY-MM-DD) | Yes | Date the document was received. |
PmdrRevDate |
string (YYYY-MM-DD) | Yes | Revision date of the document. |
Example fileDetails value:
{
"PmdId": "",
"PmdObjectType": "JBCONT",
"PmdObjectId1": "ZZ",
"PmdObjectId2": "ROVER12C",
"PmdObjectId": "ROVER12C",
"PmdTitle": "Test Document",
"PmdDesc1": "This is a test document",
"PmdDesc2": "for project 2021DEC04",
"PmdProjUuid": "9D73CB3DCDCDBF19E0536900A8C05238",
"PmdTypeCode": "ATTACHMENT",
"PmdrComment": "Test1",
"PmdrRcvdDate": "2026-05-21",
"PmdrRevDate": "2026-05-21"
}
document-content-file (file)
The actual file to upload as the document attachment. Select the file from your local filesystem.
Security
HTTP
Type basic
Basic authentication
Header parameters
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourceitem+json
Body parameters
object
fileDetails
string
Example{
"PmdId": "",
"PmdObjectType": "JBCONT",
"PmdObjectId1": "ZZ",
"PmdObjectId2": "ROVER12C",
"PmdObjectId": "ROVER12C",
"PmdTitle": "Test Document",
"PmdDesc1": "This is a test document",
"PmdDesc2": "for project 2021DEC04",
"PmdProjUuid": "9D73CB3DCDCDBF19E0536900A8C05238",
"PmdTypeCode": "ATTACHMENT",
"PmdrComment": "Test1",
"PmdrRcvdDate": "2026-05-21",
"PmdrRevDate": "2026-05-21"
}
document-content-file
string (binary)
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/json
{
"result": "Document Uploaded Successfully",
"pmdRevOraseq": 842843699,
"pmdTitle": "Test Document",
"pmdUuid": "0164DED6D2E048EAE06316821FAC3745",
"pmdRevNum": "0",
"pmdRevUuid": "0164DED6D2E248EAE06316821FAC3745",
"pmdId": "842843698"
}object