Jump to

• Request
• Response

Use the Add Document action on a resource.

post

/custom-actions/addDocuments/{resourceName}

Request

Path Parameters

• resourceName(required): string
  Target resource name.

Header Parameters

• Prefer: string
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• addNewRevision: boolean
  Whether to add a new revision.
• contentManagementSystem: string
  The content management system GID.
• documentContent(required): string (byte)
  Base64 encoded document content.
• documentNumber: string
  The document number.
• documentType: string
  The document type GID.
• fileNameWithExtension: string
  File name including extension.
• mimeType: string
  MIME type of the uploaded content.
• pks(required): array pks
  Minimum Number of Items: 1

  List of primary keys (GIDs) for target objects.

{
    "type":"object",
    "properties":{
        "pks":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"string"
            },
            "description":"List of primary keys (GIDs) for target objects."
        },
        "fileNameWithExtension":{
            "type":"string",
            "description":"File name including extension."
        },
        "mimeType":{
            "type":"string",
            "description":"MIME type of the uploaded content."
        },
        "documentType":{
            "type":"string",
            "description":"The document type GID."
        },
        "documentNumber":{
            "type":"string",
            "description":"The document number."
        },
        "addNewRevision":{
            "type":"boolean",
            "description":"Whether to add a new revision."
        },
        "contentManagementSystem":{
            "type":"string",
            "description":"The content management system GID."
        },
        "documentContent":{
            "type":"string",
            "format":"byte",
            "description":"Base64 encoded document content."
        }
    },
    "required":[
        "pks",
        "documentContent"
    ],
    "anyOf":[
        {
            "required":[
                "fileNameWithExtension"
            ]
        },
        {
            "required":[
                "mimeType"
            ]
        }
    ]
}

Nested Schema : pks

Type: array

Minimum Number of Items: 1

List of primary keys (GIDs) for target objects.

Show Source

• Array of: string

{
    "type":"array",
    "minItems":1,
    "items":{
        "type":"string"
    },
    "description":"List of primary keys (GIDs) for target objects."
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.resource+json;type=collection

200 Response

Success! A successful POST method returns a 200 status code.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : schema

Type: object

Show Source

• cmsParams: cmsParams
• contentManagementSystemGid: string
  No description.
• contents: contents
• contexts: contexts
• documentCmsId: string
  Read Only: true

  A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
• documentDefGid: string
  No description.
• documentFilename: string
  No description.
• documentGid: string
  No description.
• documentMimeType: string
  No description. This attribute is marked as Create-Only.
• documentTrackingNum: string
  No description.
• documentType: string
  Read Only: true

  No description.
• documentUrl: string
  Read Only: true

  No description.
• documentXid: string
  No description.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  represents effective date for a document
• expirationDate: expirationDate
  Represents expiration date for a document.
• generatedAt: generatedAt
  If preparation, date/time content was last generated
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• ownerDataQueryTypeGid: string
  No description.
• ownerObjectGid: string
  No description.
• relatedDocument: relatedDocument
  Read Only: true

  This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)
• relatedDocumentGid: string
  Represents the related document for consolidated/linked documents.
  This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)
• reportGid: string
  The report associated with the document attachment, if content was generated by the report subsystem.
• statuses: statuses
• updateDate: updateDate
  Read Only: true

  update date
• uploadedAt: uploadedAt
  If attachment, date/time content was last updated
• usedAs: string
  Represents the classification of a document.(C/I/L/T)
• userDefined1IconGid: string
  No description.
• userDefined2IconGid: string
  No description.
• userDefined3IconGid: string
  No description.
• userDefined4IconGid: string
  No description.
• userDefined5IconGid: string
  No description.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentType":{
            "description":"No description.",
            "type":"string",
            "readOnly":true
        },
        "documentMimeType":{
            "description":"No description. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "ownerObjectGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string",
            "readOnly":true
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents. <br> This property will be displayed only when expandRefs query parameter is set to false (expandRefs=false)",
            "type":"string"
        },
        "relatedDocument":{
            "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
            "allOf":[
                {
                    "$ref":"#/components/schemas/documents"
                }
            ],
            "readOnly":true
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "contexts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contexts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "cmsParams":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.cmsParams"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "contents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/documents.contents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : cmsParams

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.cmsParams"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.contents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : contexts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.contexts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

represents effective date for a document

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Represents expiration date for a document.

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

If preparation, date/time content was last generated

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : relatedDocument

Read Only: true

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Match All

This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)

Show Source

• object schema

{
    "description":"This property is a reference resource (a resource that is referred via a foreign key) of the property relatedDocumentGid, which will be expanded if expandRefs query parameter is set to true (expandRefs=true)",
    "allOf":[
        {
            "$ref":"#/components/schemas/documents"
        }
    ],
    "readOnly":true
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/documents.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

If attachment, date/time content was last updated

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.cmsParams"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• paramName: string
  Parameter name
• paramValue: string
  Parameter value

{
    "properties":{
        "paramName":{
            "description":"Parameter name",
            "type":"string"
        },
        "paramValue":{
            "description":"Parameter value",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.contents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentContentGid: string
  NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContentGid":{
            "description":"NOTE: This column should not have an FK to OCUMENT_CONTENT. The DOCUMENT_CONTENT table may be stored in a different instance or schema.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.contexts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• documentContextQualGid: string
  Represents the document context qualifier.
• documentContextValue: string
  Represents the value of a document context qualifier.
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "documentContextQualGid":{
            "description":"Represents the document context qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "documentContextValue":{
            "description":"Represents the value of a document context qualifier.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/documents.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• statusTypeGid: string
  No description.
• statusValueGid: string
  No description.

{
    "properties":{
        "statusTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

400 Response

Your request couldn't be processed because it contains missing or invalid information. For example, a validation error on an input field or a missing required value.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

401 Response

Unauthorized. The request was not successful because it is missing valid authentication credentials for the requested resource.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

403 Response

Access to the specified resource has been forbidden.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Body ()

Root Schema : errorResponse

Type: object

Show Source

• detail(required): string
  Provides more information about the error.
• status(required): number
  HTTP status code.
• title(required): string
  Provides a short summary message.

{
    "properties":{
        "status":{
            "description":"HTTP status code.",
            "type":"number"
        },
        "title":{
            "description":"Provides a short summary message.",
            "type":"string"
        },
        "detail":{
            "description":"Provides more information about the error.",
            "type":"string"
        }
    },
    "required":[
        "status",
        "title",
        "detail"
    ]
}

Back to Top