Version 1
Connector Overview: This page documents all 756 actions for the Orangelogicconnector v1.
ACCESSKEYGENERATOR
GET Visibility: [EVERYONE]
/api/ACCESSKEYGENERATOR/v1.0/Register
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Request id |
|
|
For what application do we need to generate an access key |
|
|
Random string |
|
|
Client's OS |
|
|
Allows to skip IP validation |
|
|
Allows to turn on debug mode |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AJ_AGENTJOBS_DbBO
GET Deprecated
/api/AJ_AGENTJOBS_DbBO/v1.0/TriggerJob
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Deprecated, will be ignored |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AccessKeyAuthentication (3)
GET Visibility: [EVERYONE]
/api/AccessKeyAuthentication/v1.0/Configure
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
DebugLevel on the server. From 0 to 5 |
|
|
User id or email to impersonate |
|
|
SecurityLevel. Values: from 0 to 2. 2 means highest |
|
|
VerboseLogging |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Visibility: [EVERYONE]
/api/AccessKeyAuthentication/v1.0/AuthenticateInternal
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
user's email hash |
|
|
For what application do we need to generate an access key |
|
|
Random string |
|
|
Client's OS |
|
|
Allows to skip IP validation |
|
|
Allows to turn on debug mode on the server |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Visibility: [REGISTERED_USERS]
/api/AccessKeyAuthentication/v1.0/UpdateAjaxToken
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Encrypted Ajax Token to fill out for the session |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ActivityDetectorApp
GET API endpoint to get the current version of ActivityDetector application.
/api/ActivityDetectorApp/v1.0/CurrentVersionInfo
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Agent (4)
GET API to check the last execution of critical jobs. Example call http://sentinel.com/API/Agent/v1.0/CheckActivity
/api/Agent/v1.0/CheckActivity
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
If True, then will only return errors |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to create a new agentJob http://sentinel.com/API/Agent/v1.0/AgentJob:Create? Note: The API call should be launched on both primary and secondary sites if the agent job is needed on both sites. This is because agent jobs do not replicate between sites.
/api/Agent/v1.0/AgentJob:Create
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Field JobName of the new job |
|
|
Field FunctionName to call |
|
|
Field Delay between each runs |
|
|
Field DatabaseName of the new job |
|
|
Field ParametersList of the new job |
|
|
Field ParameterBasePath of the new job |
|
|
Field ParameterProfile of the new job |
|
|
Field JobToRunAfter_1 of the new job |
|
|
Field JobToRunAfter_2 of the new job |
|
|
Field JobTimeout of the new job |
|
|
Field JobEmail of the new job |
|
|
Field JobPriority of the new job |
|
|
Field JobActive of the new job |
|
|
Field RunJobWhenPrimary of the new job |
|
|
Field RunJobWhenBackup of the new job |
|
|
Field RunJobWhenTest of the new job |
|
|
Field RunJobWhenImport of the new job |
|
|
Field RunJobWhenStandby of the new job |
|
|
Field RunJobWhenSecondary of the new job |
|
|
Field RunInSeperateExe of the new job |
|
|
Delete the job if it already exists. This parameter is ignored if SkipIfExists is set to true. |
|
|
Skip the job if it already exists |
|
|
Check existence on function name only |
|
|
Field Schedule_StartDate of the new job |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Copy the Schedule From Old SearchIndexing Full to FullPreindexRecomputation
/api/Agent/v1.0/AgentJob:AlignFullIndexingSchedule
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Deactivate full indexing job. Note: The API call should be launched on both primary and secondary sites if the agent job existed on both sites. This is because agent jobs do not replicate between sites.
/api/Agent/v1.0/AgentJob:DeactivateFullIndexing
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Announcements (7)
GET Create a new announcement
/webapi/framework/announcements/createannouncement_448_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Title of this announcement |
|
|
Description of this announcement |
|
|
If filled, this announcement will be clickable to redirect to this URL |
|
|
A list of VPages or workspaces to show this announcement to. |
|
|
ID of the announcement template that will be displayed. |
|
|
This announcement will be activated when current date is after this date and before OrangeLogic.Contracts.Framework.Announcements.CreateAnnouncementRequest.EndDate. |
|
|
This announcement will be activated when current date is before this date and after OrangeLogic.Contracts.Framework.Announcements.CreateAnnouncementRequest.StartDate. |
|
|
Return true when this announcement can be dismissed. Return false when this announcement cannot be dismissed. |
|
|
Return true when this announcement can reappear even after user dismissed it. Return false when this announcement won't appear after user dismissed it. |
POST Delete one or more announcement
/webapi/framework/announcements/delete_443_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
List of announcement IDs to delete |
POST Dismiss an announcement.
/webapi/framework/announcements/dismiss_447_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Announcement ID to dismiss |
|
|
User dismisses this announcement |
GET Return active announcements and upcoming announcements. The result will contain dismissed announcements that can be reappear even user dismissed it.
/webapi/framework/announcements/getactiveorincomingannouncements_444_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter active or upcoming announcements apply to this user. Optional, If empty, it won't filter by user |
|
|
Filter active or upcoming announcements apply to this workspace. Optional, If empty, it won't filter by workspace |
|
|
Filter only announcements in specific VPage. |
|
|
N/A |
GET Return active announcements that should appear for user.
/webapi/framework/announcements/getactiveannouncements_446_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter by this user ID Optional, if this property is empty, it will list announcements for anyone. |
|
|
WorkspaceID to filter for the announcements. |
|
|
Filter only announcements in specific VPage. |
|
|
N/A |
GET Return announcements that already end and announcements that already dismissed.
/webapi/framework/announcements/getpreviousordismissedannouncements_445_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter announcements which apply to this user. Optional, if enpty, it won't filter by user. |
|
|
WorkspaceID to filter for the announcements. |
|
|
Filter only announcements in specific VPage. |
|
|
N/A |
POST Update one or more announcements
/webapi/framework/announcements/updateannouncements_449_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Approval (3)
GET Change the select state for a document in a select virtual folder
/api/Approval/v1.0/ChangeSelectState
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
State to active/deactive |
|
|
Active or deactive this state |
|
|
Asset share to fetch config |
|
|
Document recordID to change state |
|
|
Keyword recordID |
|
|
Contextual folder RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Compute the ApprovalStatus basing on approvers' decision for a list document.
/api/Approval/v1.0/BulkComputeApprovalStatus
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Compute the ApprovalStatus basing on approvers' decision.
/api/Approval/v1.0/ComputeApprovalStatus
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AssetLink (2)
GET Creates a shared link to the asset
/api/AssetLink/v1.0/CreateFormatLink
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Image identifier |
|
|
Defines if we should stick to the current version (true value) or we should link to the most recent version (false value) |
|
|
Defines if we should log every access |
|
|
Defines if we should create download or view link |
|
|
Format to share |
|
|
Expires on |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Creates a shared link to the asset
/api/AssetLink/v1.0/CreateCropLink
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Image identifier |
|
|
Defines if we should log every access |
|
|
Defines if we should create download or view link |
|
|
Ratio of top Y coordinate of crop rectangle to the being cropped image's height |
|
|
Ratio of left X coordinate of crop rectangle to the being cropped image's width |
|
|
Ratio of bottom Y coordinate of crop rectangle to the being cropped image's height |
|
|
Ratio of right X coordinate of crop rectangle to the being cropped image's width |
|
|
Height of the final image |
|
|
Width of the final image |
|
|
Should apply a watermark on the crop |
|
|
Expires on |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AssetProcessingServiceAPI_BO (3)
GET API to help schedule asset processing background task
/api/AssetProcessingServiceAPI_BO/1.0/ScheduleAssetProcessingAction
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Triggered user |
|
|
Service ID |
|
|
Re-process |
|
|
Run on children |
|
|
Unstack |
|
|
Bypass permissions check |
|
|
Optional configurations |
|
|
Show toast messages |
|
|
Additional configurations. Used by calls from triggers (data points). |
|
|
Force Async Processing job execution location |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to perform a service processing on media assets
/api/AssetProcessingServiceAPI_BO/1.0/PerformAssetProcessing
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Service Id |
|
|
Target RecordID |
|
|
Additional configurations |
|
|
Re-process on previously run assets |
|
|
Expand the folders and create processes for children assets |
|
|
Requestor ERID |
|
|
Optional transaction ID |
|
|
Optional indicate status when retry multiple times |
|
|
Force Async Processing job execution location |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to schedule the process to be performed on batch of assets
/api/AssetProcessingServiceAPI_BO/1.0/ScheduleAssetProcessing
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Service Id |
|
|
Target RecordID |
|
|
Re-process on previously run assets |
|
|
Additional configurations |
|
|
Expand the folders and create processes for children assets |
|
|
Requestor ERID |
|
|
Optional transaction ID |
|
|
Send email on finished |
|
|
Force priority for processing task |
|
|
Force Async Processing job execution location |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AsyncTaskNotifier_BO
GET Get the list of monitoring tasks for the current user
/api/AsyncTaskNotifier_BO/1.0/GetMonitoringTasks
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Audio (2)
GET Extracts an image of the waveform form the audio file and sets it as the representative of the asset.
/api/Audio/v1.1/ExtractWaveformAsRepresentative
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier of the audio file to process |
|
|
Override existing representative |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Launch async tasks to extract an the waveform images and set as representative for all audio files. User must have appropriate security function to use this API.
/api/Audio/v1.0/ExtractAudioWaveforms
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of audio identifiers to filter |
|
|
Size of a processing batch |
|
|
Override existing representative |
|
|
Client transaction ID |
|
|
Override existing waveform |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Authentication (10)
GET An API to get back the token
/api/Authentication/v1.0/AccessToken
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
POST Authenticate a user given the client credentials
/webapi/security/clientcredentialsauthentication/authenticate_46H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Provided client ID |
|
|
Provided client secret |
GET Get or create the current session's access key for a context.
/webapi/security/authentication/getorcreatecontextaccesskey_22S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Context the access key is for
|
|
|
Device hash the access key is attached to |
|
|
OS of the device |
|
|
Whether or not the key is restricted to an IP address |
|
|
Validity duration of the fetched access key; unit is in minutes |
|
|
N/A |
GET Get the bearer authentication token for a user
/webapi/security/bearerauthentication/getbearertoken_42P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The email of the account to get the bearer token |
|
|
N/A |
GET Get the client credentials of the user making the request
/webapi/security/clientcredentialsauthentication/getclientcredentials_46G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the current session's access key for a context.
/webapi/security/authentication/getcontextaccesskey_21K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Context the access key is for
|
|
|
Device hash the access key is attached to |
|
|
N/A |
POST Obtain a login token from Cortex. Note: Only POST requests are supported.
/api/Authentication/v2.0/Login
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Login for the user. |
|
|
Password for the user. |
|
|
Include User Email in Response |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Start impersonation
/webapi/security/authentication/startimpersonation_4CN_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
CTRecordID of the user being impersonated
|
|
|
Email of the user who being impersonated |
|
|
N/A |
GET Stop impersonation
/webapi/security/authentication/stopimpersonation_4CO_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Turn bearer token authentication on/off for a contact
/webapi/security/bearerauthentication/setactivation_42Q_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The email of the account to set activation state for the bearer authentication |
|
|
Activation state for the bearer authentication |
|
|
N/A |
Authorization (3)
POST Get OAuth token
/webapi/security/oauth2/token_48I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Client ID |
|
|
Client secret |
|
|
OAuth grant type values coming from HTTP requests
|
|
|
Authorization code |
|
|
Authorization code |
|
|
PKCE code verifier
|
GET Get current user info
/webapi/security/oauth2/userinfo_490_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get list of authorized objects for a UsageRight
/webapi/objectmanagement/authorization/getauthorizedobjects_44H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of RecordId to check |
|
|
Right to check if user has permission |
|
|
Force include binned asset
|
|
|
N/A |
AutoCompletion
POST Execute query
/webapi/ui/autocompletion/executequery_4JD_v1-alpha
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Search term |
|
|
Query module name |
|
|
Filter module name |
|
|
Max results count to return |
|
|
Additional viewstate |
|
|
Column to group by |
AutoDiscovery
GET Get list of monitored Cortex instances.
/webapi/infrastructure/autodiscovery/getcortexinstances_230_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Optional filter for the minimum Cortex version
Ex. XANADU.A6.1500A.46000 |
|
|
N/A |
AvatarGenerator
GET Generate unique avatar for each hash
/api/AvatarGenerator/v1.0/Generate
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AzureFaceAPI_BO (3)
GET Assign faces to a person & train the model
/api/AzureFaceAPI_BO/1.0/TrainFaces
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Extra data-points, containing the tags |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Detect faces in an image
/api/AzureFaceAPI_BO/1.0/DetectFaces
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Perform facial recogntion task on a set of assets
/api/AzureFaceAPI_BO/1.0/FacialRecognizeV2
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
AzureVideoIndexerV2_BO
GET Index media utilizing Azure service
/api/AzureVideoIndexerV2_BO/1.0/IndexMedia
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Parameters |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Bidding (2)
GET Get suggestions
/webapi/invisiblehand/bidding/getsuggestions_441_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The source name which hold transactions
|
|
|
The source ID which holds transactions |
|
|
The user to check credits and list available options. |
|
|
The currency code of amount.
|
|
|
The overridden of credits for objects |
|
|
Alternative dependent date to use for master instead of fetching from "current" value |
|
|
Multiplier items (user, category, multipler value) |
|
|
Working hours (user, category, hours). |
|
|
N/A |
GET Get suggestions in simulation mode
/webapi/invisiblehand/bidding/getsuggestionssimulation_442_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The user to check credits and list available options. |
|
|
Code of the category |
|
|
The currency code of amount.
|
|
|
Estimation time (in minute) to simulate |
|
|
Fetched objects info for each user |
|
|
Multiplier items (user, category, multipler value) |
|
|
Working hours (user, category, hours). |
|
|
N/A |
CMS4
GET Open CMS4 in a panel
/api/CMS4/v1.0/Open
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The target object to display CMS4 on |
|
|
Root node of CMS4 to display |
|
|
Force the root template display the form |
|
|
The target module to work on |
|
|
Test |
|
|
The record ID of an existed form attemp to display |
|
|
Mode |
|
|
Additional configurations. Supported keys: ParentID |
|
|
If true, open form in new tab. Otherwise show the Form as popup |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
CMS4_WhatsNew_BO
GET Migrate the content of field Title to field CaptionLong for all news nodes.
/api/CMS4_WhatsNew_BO/v1.0/MigrateFieldTitleContentToFieldCaptionLong
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Calendar (3)
GET De-active a recurring event series
/webapi/objectmanagement/calendar/recurringevents/deactive_426_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The document ID to schedule |
|
|
N/A |
GET Propage changes to occurrence events
/webapi/objectmanagement/calendar/recurringevents/propagatechanges_424_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of document to propage chages (could be the original event or an occurrence one) |
|
|
Propagation type |
|
|
Applying changes mode, should be either
|
|
|
N/A |
GET Schedule a recurring event series
/webapi/objectmanagement/calendar/recurringevents/schedule_425_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The document ID to schedule |
|
|
Frequency |
|
|
Number of occurrences |
|
|
N/A |
Captions (5)
POST Add new or update a caption track of the video
/webapi/mediafile/captions/420_v1/{videoID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MediaEncryptedIdentifier of Video |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Label of the caption, must be unique on a video |
|
|
Language of the caption |
|
|
Format of the caption (subrip, webvtt, etc...) |
|
|
Content of the caption, please make sure it follow the above format |
PUT Append new paragraph to a video's caption track
/webapi/mediafile/captions/appendcaptionparagraph_422_v1/{videoID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MediaEncryptedIdentifier of Video |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Label of the caption |
|
|
Raw content of the paragraph in VTT convention |
GET Get all caption tracks for video
/webapi/mediafile/captions/41Z_v1/{videoID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MediaEncryptedIdentifier of Video |
|
|
N/A |
DELETE Remove caption track from a video
/webapi/mediafile/captions/423_v1/{videoID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MediaEncryptedIdentifier of Video |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Label of the deleting caption |
POST Rename caption track label
/webapi/mediafile/captions/renamelabel_421_v1/{videoID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MediaEncryptedIdentifier of Video |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Name of an existing label |
|
|
New name of the label |
ClientInformation
GET An API to get the current location on the website
/api/ClientInformation/v1.0/GetLocation
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ClusterManagement (5)
GET Get current status of services in the cluster
/webapi/application/cluster/describeservicesstatus_21r_v1-beta
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get list of events
/webapi/application/cluster/getlastevents_221_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Get event older than this date (UTC), meaning they occured before (or at) this date |
|
|
Number of events to return |
|
|
if provided, get only events related to this service |
|
|
if provided, get only events of that type (start / stop / scale / ...) |
|
|
N/A |
GET Get the cloud instance ID on the cloud provider
/webapi/application/cluster/getECSTaskARN_4F4_v1-beta
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Get the cloud instance information based on the cloud ID
/webapi/application/cluster/gettaskinformation_4EL_v1-beta
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The cloud instance ID of the task
|
GET List all available versions for a major release.
/webapi/application/versions_4l2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
E.g. "ANN ARBOR" |
|
|
N/A |
Collaboration (8)
POST Add a new user custom color into the palette
/webapi/ui/collab/tiptap/add_user_custom_color_4FE_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User custom color |
|
|
N/A |
POST Get TipTap YDoc
/webapi/ui/collab/tiptap/getydoc_4ky_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get attachment url
/webapi/ui/collab/tiptap/getattachmenturl_4m9_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Attachment ID |
|
|
N/A |
GET Get user custom color palette
/webapi/ui/collab/tiptap/get_user_custom_colors_4FD_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User ID |
|
|
N/A |
GET Get user info in a collaboration context
/webapi/ui/collab/tiptap/getusercollabinfo_4la_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User ID list |
|
|
Flag to indicate whether user is using dark mode
|
|
|
N/A |
POST Send email about the suggestions added to document owner
/webapi/ui/collab/tiptap/sendsuggestionnotiemail_4um_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Set TipTap YDoc
/webapi/ui/collab/tiptap/setydoc_4kz_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate authentication token
/webapi/ui/collab/tiptap/validateauthtoken_4uk_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The token to validate |
|
|
ID of the collaboration context that the token will be validated against |
|
|
Id of the SignalR connection |
Compression (4)
GET API to rebuild cache CSS
/api/Compression/v1.0/ClearCacheCSS
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Force rebuild of cache CSS even if it already exists. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Check if the given asset is a password-protected zip file
/webapi/mediafile/fileextract/isencrypted_41P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the Document. It can be document encrypted RecordID, RecordID or Identifier |
|
|
N/A |
GET Clear cache Javascript. Has option to decide only create new Javascript cache when there is no cache available. Default is do nothing when there is already a cache.
/api/Compression/v1.0/ClearCacheJS
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Force rebuild cache JS even there is existing cache. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
POST Request to unzip and import the extracted assets to Cortex
/webapi/mediafile/fileextract/unzip_41O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the Document. It can be document encrypted RecordID, RecordID or Identifier |
|
|
Password to unzip if necessary |
Contact (14)
POST Create an impersonation escalation link of the Source Contact with Target Contact
/webapi/crm/contact/impersonation/createlink/sourcectwithtargetct_48J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
POST Create an impersonation escalation link of the Source Contact with Target Group
/webapi/crm/contact/impersonation/createlink/sourcectwithtargetcg_48K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
POST Create an impersonation escalation link of the Source Group with Target Contact
/webapi/crm/contact/impersonation/createlink/sourcecgwithtargetct_48L_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
POST Create an impersonation escalation link of the Source Group with Target Group
/webapi/crm/contact/impersonation/createlink/sourcecgwithtargetcg_48M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
GET Find all the groups with details for the provided user
/webapi/crm/group/findgroupinfoforuser_44N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the contact |
|
|
Login ID or Email of the contact |
|
|
N/A |
GET Get all contacts / groups that have impersonate link with this the source contact (include parent group of source contact)
/webapi/crm/contact/impersonation/getlink/contact_48N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of main Contact / Group
|
|
|
N/A |
GET Get all contacts / groups that have impersonate link with this the source group (include parent group of source group)
/webapi/crm/contact/impersonation/getlink/group_48O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of main Contact / Group
|
|
|
N/A |
GET Get the base information of user from the the contact id
/webapi/crm/contact/contactinformation/contactinformation/getcontractbaseinformationfromID_4A6_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List ID of contact |
|
|
N/A |
POST Import contacts from CSV file
/webapi/crm/contact/importcsv/contact/importcontacsfromcsv_4C7_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
CSV file |
|
|
The fields mapping between fields name and CSV header |
DELETE Remove an impersonation escalation link of the Source Contact with Target Contact
/webapi/crm/contact/impersonation/removelink/sourcectwithtargetct_48P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
DELETE Remove an impersonation escalation link of the Source Contact with Target Group
/webapi/crm/contact/impersonation/removelink/sourcectwithtargetcg_48Q_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
DELETE Remove an impersonation escalation link of the Source Group with Target Contact
/webapi/crm/contact/impersonation/removelink/sourcecgwithtargetct_48R_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
DELETE Remove an impersonation escalation link of the Source Group with Target Group
/webapi/crm/contact/impersonation/removelink/sourcecgwithtargetcg_48S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of main Contact / Group
|
|
|
The ID of Contact / Group that being allowed by the Main Contact / Group to take more advanced when impersonate
|
POST Set multiple vacation for multiple users with multiple vacation periods
/webapi/crm/contact/vacation/setmultiplevacationforusers_4C0_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
ContactDocumentLinks (4)
GET Add permissions to a list of users, groups or roles
/api/ContactDocumentLinks/v2.0/AddPermission
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid (inner call supported) |
|
|
Rights. Use , to separate rights if you want to provide multiple rights at once (e.g. Rights=CanRead,CanWrite,CanDelete) |
|
|
Users to assign the permissions to (inner call supported). Use | to separate users if you provide multiple users directly (e.g. Contacts=ContactID1|ContactID2|ContactID3) |
|
|
Groups to assign the permissions to |
|
|
Roles to assign the permissions to |
|
|
Also add permission to referenced assets |
|
|
The end date of the permission if it's not permanent |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Add permissions to a list of users, groups or roles
/api/ContactDocumentLinks/v1.0/AddPermission
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Rights |
|
|
Users to assign the permissions to |
|
|
Groups to assign the permissions to |
|
|
Roles to assign the permissions to |
|
|
Also add permission to referenced assets |
|
|
The end date of the permission if it's not permanent |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Remove permissions to a list of users, groups or roles
/api/ContactDocumentLinks/v2.0/RemovePermission
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Rights to remove |
|
|
Users to remove the permissions for |
|
|
Groups to remove the permissions for |
|
|
Roles to remove the permissions for |
|
|
Also remove permission to referenced assets |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Remove permissions to a list of users, groups or roles
/api/ContactDocumentLinks/v1.0/RemovePermission
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Rights to remove |
|
|
Users to remove the permissions for |
|
|
Groups to remove the permissions for |
|
|
Roles to remove the permissions for |
|
|
Also remove permission to referenced assets |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ContactGroups (4)
GET API to Create the given system group
/api/ContactGroups/v1.0/CreateSystemGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
System Group which is to be created |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to add the List Security Right for the 'Source' Security function for the *Everybody system group
/api/ContactGroups/v1.0/AddSourceSecurityForEveryoneGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to add the a Security Right to *Everybody system group
/api/ContactGroups/v1.0/AddSecurityForEveryoneGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Security code to add to *Everyone |
|
|
Right name to apply for security (None, Read, Edit, New, Delete, UnDelete, List, Full) |
|
|
Only execute this API for specific client short name |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to assign the group merge tool security to *Admin group.
/api/ContactGroups/v1.0/AssignGroupMergeToolSecurityToAdminGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Contacts (4)
GET API to alter the contact type of a given contact
/api/Contacts/v1.0/ChangeContactType
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the contact which is to have its type changed |
|
|
Identifier of the contact which is to have its type changed |
|
|
Primary Email of the contact which is to have its type changed |
|
|
LoginID of the contact which is to have its type changed |
|
|
Contact type which the detected contact will be converted to |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Generate a Contact Event and link against a specific contact
/api/Contacts/v1.0/GenerateContactEvent
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Event type code |
|
|
Title of the event to be generated. If not specified, we fallback to the subject of the Event Type |
|
|
Detail of the event to be generated. If not specified, we fallback to the body of the Event Type |
|
|
ID of the contact to be link against the event to be geneted. It can take RecordID (encrypted), LoginID or Email of the contact |
|
|
Send notifications when the event is generated |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Set password for contact. Only POST requests are supported.
/api/Contacts/v1.0/SetPassword
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Contact email |
|
|
Contact password. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Validate intput password for a contact. Only POST requests are supported.
/api/Contacts/v1.0/ValidatePassword
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Contact email |
|
|
Contact password. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Conversion
POST Flag documents that need decryption or encryption
/webapi/mediafile/conversion/pdf/converttopdf_44W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Different modes of ingest on the generated PDF |
|
|
N/A |
CortexContainers
GET API to validate site containers are all aligned in terms of Cortex version. Example call https://mysite.com/API/CortexContainers/v2.0/ValidateSiteContainers
/api/CortexContainers/v2.0/ValidateSiteContainers
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
CortexDrive (16)
POST Cancel upload item
/webapi/cortexdrive/cancel_upload_4W4_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the item being canceled |
POST Check chunks integrity
/webapi/cortexdrive/check_chunks_integrity_26W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
UploadItemID of the file being uploaded |
|
|
Total file size of the uploaded file |
|
|
Optional parameter to perform a check to see if we can assemble a complete file with the uploaded chunks |
POST Check upload item status
/webapi/cortexdrive/check_upload_status_25M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
UploadItemID of the files being uploaded |
POST Create story - idempotent
/webapi/cortexdrive/create_story_idempotent_28B_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Title of the folder to be created |
|
|
Record ID of the parent folder (either this or ParentIdentifier must be filled) |
|
|
Idempotent key to prevent duplicate creation |
POST Mark the upload item as completed and ready to be ingested
/webapi/cortexdrive/complete_upload_25J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Upload item Id |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
Expected file size of the uploaded file |
|
|
Flag to force async inline asset process |
|
|
Force semi sync |
POST Register upload items
/webapi/cortexdrive/register_upload_item_244_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Id of target forlder to upload to |
|
|
Should folder structure be preserved during upload
|
|
|
Name of the uploader being used to provide more info
|
|
|
Skip validity check
|
|
|
Identifier of calling client |
GET Retrieve children of the requested container
/webapi/cortexdrive/getchildren_23U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Required list of elastic search fields to retrieve with the records.
DO_RECORDID IDENTIFIER_STRING_INDEXED EDITDATE_DATE_INDEXED BINNED_BOOL_INDEXED ... |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
Option to query proxy format information for the records |
|
|
Option to query asset information for the records in the GetChildren request |
|
|
List of selected doctype to filter |
|
|
N/A |
GET Retrieve children of the requested container as in the asset browser. It query children of a folder, as well as children of files under the folder directly from elastic search. This is a leaner version of M:OrangeLogic.WebApi.Controller.CortexDrive.CortexDriveController.GetChildrenAsync(OrangeLogic.Contracts.CortexDrive.GetChildrenRequest) that skip looping through the records to filter records by Criterion source.
/webapi/cortexdrive/getchildren_23U_v2
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Required list of elastic search fields to retrieve with the records.
DO_RECORDID IDENTIFIER_STRING_INDEXED EDITDATE_DATE_INDEXED BINNED_BOOL_INDEXED ... |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
Option to query proxy format information for the records |
|
|
Option to query asset information for the records in the GetChildren request |
|
|
List of selected doctype to filter |
|
|
N/A |
GET Retrieve the current version of Orange Flash app as well of the download URLs
/webapi/cortexdrive/getversion_4G5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve the list of host storages
/webapi/cortexdrive/gethotstorages_23V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve the presigned URL to download asset
/webapi/cortexdrive/getpresignedlink_23W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Encrypted Record ID/Unique Identifier of the asset |
|
|
Format code of the asset in the link (Ex: TRX, TR4,...) |
|
|
Indicates whether the asset should be generated if needed.
|
|
|
Indicates whether we need to check if the asset exists or not
|
|
|
Validity duration of the generated link.
|
|
|
N/A |
GET Retrieve the presigned URL to download older version of an asset
/webapi/cortexdrive/get_presigned_link_for_old_version_4GS_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The MD5 of the requested version |
|
|
Encrypted Record ID/Unique Identifier of the asset |
|
|
Format code of the asset in the link (Ex: TRX, TR4,...) |
|
|
Indicates whether the asset should be generated if needed.
|
|
|
Indicates whether we need to check if the asset exists or not
|
|
|
Validity duration of the generated link.
|
|
|
N/A |
POST Retrieve the presigned URLs of chunks for download/upload
/webapi/cortexdrive/get_chunk_presigned_links_from_ingest_buffer_245_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
UploadItemID of the file being uploaded |
|
|
Indicate the purpose of the presigned URL (upload or download) |
|
|
Specification of the chunks to get presigned URLs for |
POST Retrieve the presigned URLs of multiple assets
/webapi/cortexdrive/getpresignedlinks_in_batch_23Y_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Indicates whether the assets should be generated if needed.
|
|
|
Validity duration of the generated links.
|
POST Update Upload item with new ByteSize and OriginalFileName
/webapi/cortexdrive/update_upload_item_25K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Field UIRecordID of the upload item |
|
|
Field ByteSize of the upload item |
|
|
Field OriginalFileName of the upload item |
|
|
The record ID of the upload folder |
|
|
The record ID of the document of the upload item |
POST Update the CoreField.OriginalFileName or CoreField.Title of an asset
/webapi/cortexdrive/rename_asset_25L_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the asset |
|
|
New name of the asset |
|
|
New name of the asset |
CortexToolsApp (6)
GET Allows client to log a message indicating that their API server has changed during their session
/api/CortexToolsApp/v1.0/LogApiServerChangeDetected
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Initial server info |
|
|
Current server info |
|
|
User email |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Clear fast upload sessions
/api/CortexToolsApp/v1.0/ClearFastUploadSessions
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Register a fast upload session
/api/CortexToolsApp/v1.0/RegisterFastUploadSessions
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Upload session |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns properties of the file associated with the upload transaction. If absent that the properties of last accessed file is returned
/api/CortexToolsApp/v1.0/GetFileProperties
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Application version installed on the client |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the parameters / additional instructions that will be used by Cortex Tools application
/api/CortexToolsApp/v1.0/ApplicationParameters
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET This method creates a transaction to use for the file created in the same folder as the originally edited file. This file will have the same file name but different extension
/api/CortexToolsApp/v1.0/CreateTransactionForDerivativeFile
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
File that was originally edited |
|
|
Name of file that was created |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
CortexToolsDownloader (4)
GET Downloads a file
/api/CortexToolsDownloader/v1.0/DownloadFile
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Download Id |
|
|
File index in the download queue |
|
|
Start download position |
|
|
End download position |
|
|
Total expected file length |
|
|
Previous command D4 RecordID Id. It is used to determine next sub-downloadcommand |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get the direct cloud URL to download this file
/api/CortexToolsDownloader/v1.0/GetDirectCloudURLForFile
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Download Id |
|
|
File index in the download queue |
|
|
Total expected file length |
|
|
Previous command D4 RecordID. It is used to determine next sub-downloadcommand |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns files to download and potential sync instructions
/api/CortexToolsDownloader/v1.0/GetFiles
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Download Id |
|
|
Previous command D4 RecordID Id. It is used to determine next sub-downloadcommand |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns files to download and potential sync instructions
/api/CortexToolsDownloader/v1.0/GetFileInfo
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Download Id |
|
|
File index in the download queue |
|
|
Previous command D4 RecordID Id. It is used to determine next sub-downloadcommand |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
CortexUpgradeDocker (2)
GET API to create an entry of UD_UPGRADEDOCKERCONTAINERS https://cortexwebsite.com/API/CortexUpgradeDocker/v1.0/CortexUpgrade_Containers.Procedure:Create?LocationShortName=OLX&UpgradeType=Minor&EmailAddresses=test@ol.ol
/api/CortexUpgradeDocker/v1.0/CortexUpgrade_Containers.Procedure:Create
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Type of the upgrade |
|
|
Email Address of the recipient of the logs |
|
|
Specific target version to update (docker image full name) |
|
|
Location ShortName of the the upgrade |
|
|
Bypass the location short name check |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to create an entry of UD_UPGRADEDOCKERCONTAINERS \n This API does not requires security point but can be called only for minor updates from trusted sources (trusted IPs) \n https://cortexwebsite.com/API/CortexUpgradeDocker/v2.0/CortexUpgrade_Containers.Procedure:Create?LocationShortName=OLX&EmailAddresses=test@ol.ol
/api/CortexUpgradeDocker/v2.0/CortexUpgrade_Containers.Procedure:Create
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Location ShortName of the the upgrade |
|
|
Email Address of the recipient of the logs |
|
|
Specific target version to update (docker image full name) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
CortexUploader_BO (10)
GET Cancel any pending upload items of a given upload transaction
/api/CortexUploader_BO/v1.0/CancelUploads
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UT_RecordID |
|
|
Schedule a later task to clean-up again any residual items |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Cancel upload and delete residual files
/api/CortexUploader_BO/v1.0/CancelUpload
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI item RID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Mark upload as completed and set modified date for the file
/api/CortexUploader_BO/v1.0/CompleteUpload
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI item RID |
|
|
File Digitized Date |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
ETags received from S3 multipart upload requests |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Mark upload as completed and set modified date for the file
/api/CortexUploader_BO/v1.0/CompleteUploadAndIntegrateMetadata
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI item RID |
|
|
File Digitized Date |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Mark upload as completed and set modified date for the file. v1.1 change: Extend to return a ResponseNodeDictionary with more metadata: AssetVersion, Success
/api/CortexUploader_BO/v1.1/CompleteUpload
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI item RID |
|
|
File Digitized Date |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
ETags received from S3 multipart upload requests |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Notify user when all items are registered
/api/CortexUploader_BO/v1.0/CompleteUploadItemsRegistration
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Transaction RID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Post process after Resumable Upload
/api/CortexUploader_BO/v1.1/PostProcessResumableUpload
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI item RID |
|
|
UT Transaction RID |
|
|
File Digitized Date In Milliseconds |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
Forced Semi Sync |
|
|
Forced Async inline processing. If this flag is set, the upload item is processed inline in a dedicated non-blocking thread. |
|
|
ETags received from S3 multipart upload requests |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Registers upload items
/api/CortexUploader_BO/v1.0/RegisterUploadItems
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Serialized items info |
|
|
Transaction RID |
|
|
ID of the client calling this method |
|
|
Name of the uploader being used to provide more info |
|
|
Skip validity check |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Registers upload items
/api/CortexUploader_BO/v1.1/RegisterUploadItems
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Serialized items info |
|
|
Transaction RID |
|
|
ID of the client calling this method |
|
|
Name of the uploader being used to provide more info |
|
|
Skip validity check |
|
|
Update UT for incomplete UI upload |
|
|
True if this upload can use a cloud bucket as buffer |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
POST Upload file chunk
/api/CortexUploader_BO/v1.0/UploadFile
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UI RecordID |
|
|
Chunk Start index |
|
|
Chunk End index |
|
|
File length |
|
|
Chunk MD5 |
|
|
1-based part number. Required for cloud compatible uploads |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DamView
GET Saves the side panel width in the user preferences.
/api/DamView/v1.0/SaveSidePanelWidth
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
True if this is for the right panel, false if this is for the left panel. |
|
|
Type of panel displayed. |
|
|
Preferred width in pixels. |
|
|
ID of the workspace currently used on the DamView screen |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DamView_DataGrid
GET Saves the column side panel width.
/api/DamView_DataGrid/v1.0/SaveColumnSize
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
DataGrid Template ID |
|
|
Field ID of the target column |
|
|
List of all columns width in pixels, |
|
|
Sometime, First n Column is nor real, example select column, index, Can ignore |
|
|
ID of the workspace currently used on the DamView screen |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DataTable
GET Check if provided values exist on key type (authority based) of the fields
/api/DataTable/v2.2/TestValuesExistence
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Fied name (such as Geography.City) |
|
|
Values saperated by '|' |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DbMetrics
GET Fetch data from predefined metric in DatabaseMetrics_BO Example call /API/DbMetrics/v1.0/Fetch?Metric=XXX
/api/DbMetrics/v1.0/Fetch
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of metric which was defined in the DatabaseMetrics_BO table |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Deletion (2)
DELETE Request delete a list of objects
/webapi/objectmanagement/deletion/delete_44G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
RecordID list to delete |
|
|
Deletion mode for Object |
GET Search for deleted objects
/webapi/objectmanagement/deletion/getdeletedobjects_45C_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Limit the search from a specific datetime |
|
|
Limit the search to a specific datetime |
|
|
Whether to search only for binned objects (disabled objects will be excluded) |
|
|
Uri provided by the user of this service |
|
|
The page number |
|
|
N/A |
Discussions (4)
GET Create an alerting event.
/webapi/workflows/discussions/get_4fo_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Discussion ID
|
|
|
The record ID of the target record
|
|
|
Indicate if you want to get all the discussion that are attached to the target record recursively. |
|
|
The TargetPartID in DU One of its use case is in the CMS4 to store the location of the discussion |
|
|
The discussion category to filter |
|
|
The name of the VForm that we will use to retrieve the Discussion.
By default, when ParameterName empty, we will fall back to DiscussionsPreview_VForm |
|
|
N/A |
POST Create an alerting event.
/webapi/workflows/discussions/insert_4fm_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The parameter name of the module used to retrieve the discussion.
|
POST Create an alerting event.
/webapi/workflows/discussions/upsert_4fn_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The parameter name of the module used to retrieve the discussion.
|
PUT Create an alerting event.
/webapi/workflows/discussions/upsert_4fn_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The parameter name of the module used to retrieve the discussion.
|
DocCrop
GET Request to crop a specific document.
/api/DocCrop/v1.0/Request
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DocLinks
GET Add links between documents
/api/DocLinks/v1.0/AddLink
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid. This is the parent record id |
|
|
Related docs to be added. List of related document recordids, separator by default |
|
|
The link type to create relation |
|
|
MultiRelatedDocs delimiter. This delimiter is used to separate document rids in the list |
|
|
The link sub type to create relation |
|
|
Allow users to override the default rule behavior of the relation to define inheritance or not |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DocumentLogs
GET Update Status to Closed and Used State to Use for downloaded document logs of documents with corresponding invoices.
/api/DocumentLogs/v1.0/UpdateDocumentLogsWithCorrespondingInvoice
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DocumentParticipants (11)
GET Add a participant in a role on a record.
/api/DocumentParticipants/v1.0/AddParticipant
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID |
|
|
Participant |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Add participants to specific role.
/api/DocumentParticipants/v1.0/AddParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Role ID |
|
|
Participants to add to the role. If empty, add the user that calls this api |
|
|
Id of the role to get participants from. Used to copy participants from one role to another. |
|
|
Source object recordid to get paritipants from. If not filled, use TargetRecordID as SourceRecordID |
|
|
Replace all existing participants of this role |
|
|
Participant expiration date. The participants will be removed after reaching this date |
|
|
Allow to bypass permission |
|
|
Groups that are allowed to copy participants from |
|
|
Groups that are not allowed to copy participants from |
|
|
Should prevent copying inherited participants or not |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Add role to specific document.
/api/DocumentParticipants/v1.0/AddRole
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID or Role Name |
|
|
Required on creation |
|
|
Required to start |
|
|
Mandatory (alias to Required to start) |
|
|
Can expire |
|
|
Default expiration in days |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Copies participants of the source record to one or multiple target records.
/api/DocumentParticipants/v1.0/CopyParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Source object recordid |
|
|
Destination object recordids |
|
|
Roles IDs or names to copy |
|
|
Synchronize participants for all roles |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get a list of possible roles with its id
/api/DocumentParticipants/v1.0/GetRoles
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Remove participants to specific role.
/api/DocumentParticipants/v1.0/RemoveParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Role ID |
|
|
Participants to remove to the role. If empty, remove the user that calls this api |
|
|
Id of the role to get participants from. Used to remove all participants from a role that are already exists in another role. |
|
|
Source object recordid to get paritipants from. If not filled, use TargetRecordID as SourceRecordID |
|
|
Option remove all participants on this role |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Remove role to specific document.
/api/DocumentParticipants/v1.0/RemoveRole
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID or Name |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Removes a participant in a role on a record.
/api/DocumentParticipants/v1.0/RemoveParticipant
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID |
|
|
Participant |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Removes all participants on a record in any role or with specific role
/api/DocumentParticipants/v1.0/ClearParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Update participants list to specific role.
/api/DocumentParticipants/v1.0/UpdateParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Role ID |
|
|
Participants to add to the role. List of Display Name/Email/EncryptedRecordID of participants in , separator by default |
|
|
MultiParticipant delimiter |
|
|
Force Assign Participant |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Updates the participants on a record in a specific roles, remove participants who are not in the list
/api/DocumentParticipants/v1.0/SetParticipants
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document recordid |
|
|
Role ID |
|
|
Participant |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
DocumentReports
GET Generate and download a document report based on predefine template
/api/DocumentReports/v1.0/GenarateAndDownload
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Report RecordID |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Documents (11)
GET API to clone the given document to new one
/api/Documents/v1.0/CloneDocument
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Title |
|
|
Relation between given document and a new created one |
|
|
Open created document in new popup |
|
|
Active tab when open document in new popup |
|
|
Relation with another document |
|
|
Related document RecordID |
|
|
Additional Datapoints |
|
|
Override fields table cloned document |
|
|
Force skipping copy children |
|
|
New mother RecordID |
|
|
Force cloned document in first position or not. If leave empty, it will determine by DocumentsAPI_BO.Data.Clone.AddOnFirst. |
|
|
Should open a popup to ask for title when the target title is empty |
|
|
True boolean string will allow copy permission. False won't copy permission. Empty will behave like default that was configured in parameter |
|
|
Indicate if we are in the process of auto-generating recurring meeting |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to delete an asset
/api/Documents/v1.0/DeleteAsset
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID. It can be encrypted RecordID, RecordID or Identifier |
|
|
Delete mode |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to show the download popup for an asset RID
/api/Documents/v1.0/RotateImage
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Parameters |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to show the download popup for an asset RID
/api/Documents/v1.0/DownloadDocument
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to show the get link popup for an asset RID
/api/Documents/v1.0/GetDocumentLink
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to show the share popup for an asset RID
/api/Documents/v1.0/ShowSharePopup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to show the upload popup on an asset RID
/api/Documents/v1.0/ShowUploadPopup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Create new child Document
/api/Documents/v1.0/CreateChildDocument
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target Record ID |
|
|
Parent Record ID |
|
|
Child Doctype |
|
|
Child Doc Subtype |
|
|
Creation popup option Value must be No/Basic/Full/Form |
|
|
Must be filled if the creation popup type is Form |
|
|
Prefilled Values A string table between API name and Value Can contains placeholder to prefill value from parent |
|
|
Additional Datapoints |
|
|
Allow to bypass permission |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Create new document hierarchy
/api/Documents/v1.0/CreateDocumentHierarchy
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target Record ID |
|
|
Parent Record ID |
|
|
JSON representation of the hierarchy |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Set the representative to the document when it is ready to use
/api/Documents/v1.0/SetRepresentativeWhenDigitized
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target document RecordID, Identifier or Encrypted RecordID) |
|
|
Representative image RecordID, Identifier or Encrypted RecordID) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sync dependencies between objects under the given container
/api/Documents/v1.0/SyncDependencies
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Mode (Sync, SyncApplicationWide or CreateOrUpdate) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Download (2)
GET Get the full resolution image of document
/api/Download/v1.0/GetFullResolutionImage
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The encrypted record id of document |
|
|
The encrypted contextual record id |
|
|
The contextual table |
|
|
Additional security key to allow user to bypass the check on the security to download by API, permissions are still enforced. |
|
|
Indicate if this API is called by ImageZoomer, allow to view rotated version if needed |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Review pdf document.
/api/Download/v1.0/ReviewPDF
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Dropbox_ExternalServiceSync_DbBO (3)
GET Download content from Dropbox to the target folder
/api/Dropbox_ExternalServiceSync_DbBO/v1.0/DownloadFromDropbox
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Send message to users to invite them to collaborate on the Dropbox folder associated witha a document. If the document is not associated with any Dropbox folder, it will create one with pull-enabled
/api/Dropbox_ExternalServiceSync_DbBO/v1.0/SendDropboxInvites
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document recordid |
|
|
Recipent users |
|
|
Recipent groups |
|
|
Recipient roles |
|
|
Invite message |
|
|
Dropbox role in this folder |
|
|
Send the device notification to the recipient |
|
|
Default direction |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Upload content to Dropbox from the target folder
/api/Dropbox_ExternalServiceSync_DbBO/v1.0/UploadToDropbox
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Email
POST Unsubscribe email from the mailing list User will not be able to receive any email from the system Note: this need to be a post API due to https://datatracker.ietf.org/doc/html/rfc8058#section-3.2 Calling this API with invalid input too many times can cause Ddos blocked
/webapi/framework/email/subscription/unsubscribe_4EM_v1/{requestHashCode}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
EmailTemplate
GET Sends a template based email for a target object to a list of recipients (specific users, members of a group or participants with specific roles on the target document)
/api/EmailTemplate/v1.0/SendEmail
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Sender contact recordid |
|
|
Email template ID |
|
|
Free subject (used if not template ID is given) |
|
|
Free body (used if not template ID is given) |
|
|
Recipient users |
|
|
Recipient groups |
|
|
Recipient role on the target object |
|
|
Reply discussion recordid |
|
|
Review email before sending (if sent through the site) |
|
|
DataPoints |
|
|
Do not store this email in the DU_DISCUSSIONS table |
|
|
Exclude the recipient person that triggered the automation |
|
|
Filter the recipients by Everyone / InternalOnly (only Staff) / ExternalOnly (only non Staff) / PermissionValidation (be able to view related assets) |
|
|
Prevent send multi emails per receiver per target record id for each http request |
|
|
If it first call of function and target object is in incomplete state we create asynchronous task to retry |
|
|
Store trigger user recordID |
|
|
Attachments - Legacy parameter. It's not recommended to use this parameter when sharing asset - use AssetAttachments parameter |
|
|
Asset attachments : use this parameter to attach asset |
|
|
Parameter name of the BO to process the email subject, content before sending. It must inherited from EmailHTML_BO |
|
|
CC recipient users |
|
|
CC recipient groups |
|
|
CC recipient role on the target object |
|
|
BCC recipient users |
|
|
BCC recipient groups |
|
|
BCC recipient role on the target object |
|
|
Exclude the CC recipient person that triggered the automation |
|
|
Exclude the BCC recipient person that triggered the automation |
|
|
Only CC/BCC the first email in batch |
|
|
Confirmation message to be shown on sent when the review email flow is used |
|
|
Filter the roles recipients by individual contacts only / group contacts only / none (no filter) |
|
|
Filter the roles CC recipients by individual contacts only / group contacts only / none (no filter) |
|
|
Filter the roles BCC recipients by individual contacts only / group contacts only / none (no filter) |
|
|
Include inherited participants when sending email. Default is true. |
|
|
Include inherited CC participants when sending email. Default is true. |
|
|
Include inherited BCC participants when sending email. Default is true. |
|
|
If true, we will use FreeText instead of Template |
|
|
If true, enforce to run in async |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Embedding (7)
GET API to get total number of tokens on all documents (approximated by a quarter of characters count)
/webapi/mediafile/embedding/get-token-count_4L4_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Embedding ID |
|
|
N/A |
POST Create new embedding object
/webapi/mediafile/embedding/create-embedding-object_4UH_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the embedding object |
|
|
Description of the embedding object |
|
|
Is used for embedding progress |
|
|
Is searchable |
|
|
Selected embedding model |
|
|
List of document type or subtypes |
|
|
List of fields in api name to be included in the text embedding
|
|
|
Dimension of the embedding |
|
|
Should include free text fields in the text embedding |
|
|
Should include tags in the text embedding |
|
|
Search config - KNN value |
|
|
Search config - KNN num candidates |
|
|
Search config - KNN boosting factor |
|
|
Search config - KNN minimum score required |
|
|
Embedding config - Batch size |
|
|
Embedding config - AP batch size |
|
|
Embedding config - interval per batch (in days) |
|
|
Embedding config - Timout per API call (in seconds) |
|
|
Embedding config - Max degree of parallelism |
|
|
Embedding config - Max request size per thread |
|
|
N/A |
POST Force recompute a target document
/webapi/mediafile/embedding/force-recompute_4JN_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID. Can be RecordID, Identifier, Encrypted RecordID |
|
|
Embedding ID |
|
|
N/A |
GET Get information of all embedding objects
/webapi/mediafile/embedding/get-list-embedding-object_4VV_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Monitor document embedding progress
/webapi/mediafile/embedding/track-progress_4JL_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Embedding ID.
|
|
|
If true, show full statistics, else only show the progress cursor |
|
|
N/A |
DELETE Purge all generated embedded vectors for a given embedding object
/webapi/mediafile/embedding/purge-embedded-vector-of-embedding-object_4VW_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Embedding ID |
|
|
Only purge ignored embedded vectors, whose signature data is equal to string empty |
|
|
N/A |
POST Reset pointer to force recompute all documents
/webapi/mediafile/embedding/force-reset-embedding-pointer_4JM_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Embedding ID |
|
|
List of pointer types to reset |
|
|
Target Last Embedding Date cursor |
|
|
N/A |
Employee (5)
GET Get a list of all employees
/webapi/sample/employee/2f_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get count of all employees
/webapi/sample/employee/2w_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Lookup a single employee based on its id specific override for V2 - fake sample (doing nothing diff from V1, just to illustrate)
/webapi/sample/employee/2v_v2/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
employee's id |
|
|
N/A |
GET Lookup a single employee based on its id
/webapi/sample/employee/2b_v1/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
employee's id |
|
|
N/A |
GET raise a fake internal exception
/webapi/sample/employee/error_2g_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Encryption (4)
GET Encrypts a folder. All the assets present in this folder and sub-folders will be encrypted. In the future, any content moved or uploaded into this folder and sub-folders will be encrypted.
/api/Encryption/v1.0/EncryptFolder
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Cortex identifier of the folder to encrypt |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Removes encryption on a folder. The assets present in this folder and subfolders remain encrypted by default. You can set parameter DecryptExistingAssets to true to decrypt existing assets. In the future, any content moved to this folder will keep their encryption status. New content uploaded to this folder and subfolders will not be encrypted.
/api/Encryption/v1.0/DecryptFolder
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Cortex identifier of the folder to decrypt |
|
|
False to leave the folder content encrypted. True to decrypt the assets in the folder. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Requests to decrypt one or several assets
/api/Encryption/v1.0/DecryptAsset
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifiers of the assets to decrypt. Can be set to a CSV list of identifiers (example: 'ID1,ID2,ID3'). Can be set to '*' to decrypt all assets and folders of the site. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Requests to encrypt one or several assets
/api/Encryption/v1.0/EncryptAsset
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifiers of the assets to encrypt. Can be set to a CSV list of identifiers (example: 'ID1,ID2,ID3'). Can be set to '*' to encrypt all assets and folders of the site. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Events (2)
GET Logs an event in RE_RAWEVENTS
/api/Events/v2.0/LogEvent
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Event type |
|
|
Target object table |
|
|
Target object recordid |
|
|
Source user recordid |
|
|
DataPoints |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Recompute all events of given object
/api/Events/v2.0/RecomputeEvents
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Export (3)
GET Get EAD XML document create from the root folder
/webapi/objectmanagement/export/findingaids/ead/42D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The root folder that the finding aids will built from. If no rootFolder is specified, use the default folder in parameter config. |
|
|
The version of EAD that the finding aids will built from. If no version is specified, use the default version in parameter config. |
|
|
This request is to downloading an XML file or to display the XML in the browser |
|
|
N/A |
GET Get the default XSLT for the default EAD XML configuration
/webapi/objectmanagement/export/findingaids/ead/xslt_42N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The version of EAD that the finding aids will built from. If no version is specified, use the default version in parameter config. |
|
|
N/A |
GET Get the logo using in XSLT. By default, it's the logo in the page header
/webapi/objectmanagement/export/findingaids/ead/logo_42O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
FileManagement (4)
POST Generate a new representative for the media file
/webapi/mediafile/assetfile/generaterepresentative_4AC_v1
The input needs:
-
RecordID: Can be RecordID, Encrypted RecordID or the system identifier of the asset. It is required.
-
Percentage: Applied for Video only. To determine when we extract the image from the video. The value can be null or between (0 and 100).
-
Second: Applied for Video only. To determine which second we extract the image from the video. The value can be null or (greater than 0 and less than the duration of the video).
Important notes:
-
We will use the Percentage = 50%, if this property is null and the Second property is null.
-
If both Percentage and Second have value. We will use the Second value.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Can be RecordID, Identifier, Encrypted RecordID |
|
|
Applied for Video only.
|
|
|
Applied for Video only.
|
GET Return all version of an asset.
/webapi/mediafile/assetfile/getassetversions_4FS_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Can be RecordID, Encrypted RecordID or the system identifier of the asset. |
|
|
The format of the requested asset. By default, it is TRX |
|
|
N/A |
GET Stream the first media file matching the provided criteria
/webapi/mediafile/assetfile/getassetfile_42R_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The format of the requested asset |
|
|
The sort we want to use for the top asset retrieved
|
|
|
Freetext conditions (search API syntax).
|
|
|
Version to retrieve. By default, Cortex will take the latest version. If Version = 0, Cortex will retrieve the latest version as well. |
|
|
If the file is stored in a cloud bucket, will redirect the request to its presigned URL |
|
|
N/A |
POST Validate the proxy formats of documents to see if they're corrupted or not
/webapi/mediafile/assetfile/validateassetformats_4GF_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The documents to check. Each can be a RecordID or Unique Identifier |
|
|
The list of formats to validate |
|
|
If true, we'll automatically trigger the regeneration of corrupted formats |
Financial (15)
GET Convert a list of calculator answers from text or code to RecordID
/api/Financial/v1.0/Calculator.ConvertAnswersToRecordIDs
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID, Code or Label answer list, separated by | (pipe) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Credit an invoice
/api/Financial/v1.0/Transaction.Invoice.Credit
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier or RecordID of the invoice to credit |
|
|
Amount to credit |
|
|
Identifier or RecordID of the invoice item to credit. If not provided, the credit amount will be prorated against all the items in the invoice |
|
|
Date of the credit |
|
|
Public notes of the credit header |
|
|
Internal notes of the credit header |
|
|
Forced finalized date - Should be use when importing legacy invoices only - Can be set when the site is in 'Import' mode only |
|
|
Indicates if the data being injected are legacy data |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Finalize an invoice
/api/Financial/v1.0/Transaction.Invoice.Finalize
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier or RecordID of the invoice to search for |
|
|
Identifier of the invoice after finalization - Should be use when importing legacy invoices only - Can be set when the site is in 'Import' mode only |
|
|
Forced finalized date - Should be use when importing legacy invoices only - Can be set when the site is in 'Import' mode only |
|
|
Indicates if the data being injected are legacy data |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Finalize an invoice with linked order project
/api/Financial/v1.0/FinalizeInvoice
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target order project recordid |
|
|
ID of the status to set |
|
|
Show popup confirmation |
|
|
The VFormID to trigger |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Finalize royalty distribution
/api/Financial/v1.0/Transaction.Royalty.Finalize
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the Royalty distribution |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get the available calculator answers for the given question
/api/Financial/v1.0/Calculator.GetAnswers
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID, Code or Label of the calculator question |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get the calculator questions triggered by the given answer
/api/Financial/v1.0/Calculator.GetQuestions
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID, Code or Label of the calculator answer |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get the list of available sales types in the application
/api/Financial/v1.0/SalesType.GetList
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Lock royalty items
/api/Financial/v1.0/Transaction.Royalty.LockItems
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of items to lock |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Pay an invoice
/api/Financial/v1.0/Transaction.Invoice.Pay
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier or RecordID of the invoice to pay |
|
|
Identifier or RecordID of the payment to pay with |
|
|
Amount to pay |
|
|
Identifier or RecordID of the invoice item to pay. If not provided, the payment amount will be prorated against all the items in the invoice |
|
|
Forced finalized date - Should be use when importing legacy invoices only - Can be set when the site is in 'Import' mode only |
|
|
Indicates if the data being injected are legacy data |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Pay an invoice in full
/api/Financial/v1.0/Transaction.Invoice.PayInFull
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier or RecordID of the invoice to pay |
|
|
Payment type (Check / Wire Transfer / Credit Card) |
|
|
Forced finalized date - Should be use when importing legacy invoices only - Can be set when the site is in 'Import' mode only |
|
|
Indicates if the data being injected are legacy data |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Post royalties
/api/Financial/v1.0/Transaction.Royalty.Post
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the contact to post royalties for - When provided, the API will post all the pending items for this contact |
|
|
Date of the royalty distribution |
|
|
External ID that will be set on all royalty distribution items. Can be used to retrieve all the royalty distribution items impacted by this transaction |
|
|
List of allocation items to post |
|
|
Post all items for this account (will ignore the ItemIDList parameter) |
|
|
Public notes of the royalty distribution header |
|
|
Reference of the royalty distribution header |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Print a transaction
/api/Financial/v1.0/Transaction.Print
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier or RecordID of the transaction |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Refund royalty distribution
/api/Financial/v1.0/Transaction.Royalty.Refund
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the Royalty distribution |
|
|
Payment type (CreditCard / ACH / Check / ...) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Return the sales type code for the given display name
/api/Financial/v1.0/SalesType.GetCode
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Label (display name) of the sales type |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Firebrick (2)
GET Initiates a join request to the Firebrick graph
/webapi/infrastructure/firebrick/frontend/join_4EE_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Encrypted token from the graph context passed in by Cortex |
|
|
N/A |
GET Returns the graph settings from parameters to the frontend
/webapi/infrastructure/firebrick/frontend/settings_4ED_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
FixInvalidCharacterInURLName_BO
GET Replace invalid character in URL name by safe character
/api/FixInvalidCharacterInURLName_BO/v1.0/FixInvalidCharacterInURLName
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
FixInvalidKeywords
GET Modify keywords in a way to not have situation when Keyword A is lead for some keyword and in the same time has ReferTo field filled
/api/FixInvalidKeywords/v1.0/RemapInvalidLeads
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
FlowSteps (2)
POST Change the selected state of a flow step associated with an object.
/webapi/workflows/flowsteps/updatelinkstate_4l3_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Record ID of DK table that link the object to the flowstep |
|
|
New state of the flowstep |
GET Validate if an object has enough approvals for a flowstep
/webapi/workflows/flowsteps/validatemultiapprovals_44I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The targetted table, default to be DO_DOCUMENTS |
|
|
The document recordid to check the required number of votes |
|
|
The flowstep recordid or Code to check the required number of votes |
|
|
N/A |
FontIcon (2)
GET Convert a font icon to PNG
/api/FontIcon/v1.0/ConvertToPNG
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Icon code.
|
|
|
Icon size in pixel. \n: Example: 16, 32 |
|
|
Icon color in Hex or RGB format: Example: #FA0000, rgb(255, 0, 0) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Convert a font icon to PNG with name and a circle arround
/api/FontIcon/v1.0/ConvertToPNGv2
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Icon code.
|
|
|
Icon size in pixel.
|
|
|
Icon color in Hex or RGB format: Example: #FA0000, rgb(255, 0, 0) |
|
|
Name |
|
|
Border color in Hex or RGB format: Example: #FA0000, rgb(255, 0, 0) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Format (7)
POST Create a bucket in Autodesk Platform Services (APS) Object Storage Service (OSS)
/webapi/mediafile/format/3d/createapsbucket_231_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
unique bucket key to create |
GET Get a subtitles segment for a given video and langage
/webapi/mediafile/format/hls/getsegmentforhlssubtitles_23I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the corresponding video asset |
|
|
Cortex format code for the HLS master format
|
|
|
Language code of the desired subtitles
|
|
|
The 0-based position of this segment within the video |
|
|
Internal key computed by Cortex for this video and HLS master
|
|
|
N/A |
GET Get a video segment from a given video. And also apply the given watermark on the segment.
/webapi/mediafile/format/hls/gethlsvariantsegmentswatermark_23M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Start position of the segment wanna get from the input video |
|
|
End position of the segment wanna get from the input video |
|
|
RecordID of the input video |
|
|
N/A |
GET Get the master manifest content for a given video and HLS master
/webapi/mediafile/format/hls/getmanifestforhlsmaster_23E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the corresponding video asset |
|
|
Cortex format code for the HLS master format
|
|
|
Internal key computed by Cortex for this video and HLS master
|
|
|
N/A |
GET Get the master manifest content for a given video which support for realtime watermarking
/webapi/mediafile/format/hls/getmanifestforhlsvariantswatermark_23K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the corresponding video asset |
|
|
Cortex format code for the HLS variant format
|
|
|
Cortex format code for the HLS master format
|
|
|
Internal key computed by Cortex for this video and HLS master
|
|
|
N/A |
GET Get the subtitles manifest content for a given video and langage
/webapi/mediafile/format/hls/getmanifestforhlssubtitles_23H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the corresponding video asset |
|
|
Cortex format code for the HLS master format
|
|
|
Language code of the desired subtitles
|
|
|
Internal key computed by Cortex for this video and HLS master
|
|
|
N/A |
GET Get the variant manifest content for a given video and HLS variant
/webapi/mediafile/format/hls/getmanifestforhlsvariant_23D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the corresponding video asset |
|
|
Cortex format code for the HLS variant format
|
|
|
Internal key computed by Cortex for this video and HLS master
|
|
|
Indicate that do we need to apply watermark on the variant format.
it will include an API call to get the watermark version of the variant |
|
|
N/A |
GlobalTools
GET Generate a downloadable barcode with the options be passed in the parameter
/webapi/framework/globaltools/barcode/generatebarcode_484_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The content to be encoded in the the output barcode |
|
|
The format of the barcode to be generated. The values is one of the supported format by ZXing.
|
|
|
Width of the barcode to be generated |
|
|
Height of the barcode to be generated |
|
|
N/A |
GroupSecurity
GET API to assign the security function "Can manage everyone's shares" to groups with Bypass Permission's Security Function.
/api/GroupSecurity/v1.0/AssignCanManageEveryonesShares
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Group_DbBO
GET API to Create the given system group
/api/Group_DbBO/v1.0/CreateSystemGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
System Group which is to be created |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
IIIFv3 (4)
GET Endpoint to return a resource presentation, which gives a specificcation for presenting images. https://iiif.io/api/presentation/3.0/
/api/IIIFv3/v1.0/Presentation
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of an resource |
|
|
ResourceType |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Endpoint to return an image based on the client's requests
/api/IIIFv3/v2.0/RequestImage
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the image |
|
|
Rectangular portion of the underlying image content to be returned |
|
|
Specifies the dimensions to which the extracted region, which might be the full image, is to be scaled |
|
|
Specifies mirroring and rotation |
|
|
Determines whether the image is delivered in color, grayscale or black and white |
|
|
Expressed as a suffix, mirroring common filename extensions, at the end of the URI |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Endpoint to return an image based on the client's requests
/api/IIIFv3/v1.0/RequestImage
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the image |
|
|
Rectangular portion of the underlying image content to be returned |
|
|
Specifies the dimensions to which the extracted region, which might be the full image, is to be scaled |
|
|
Specifies mirroring and rotation |
|
|
Determines whether the image is delivered in color, grayscale or black and white |
|
|
Expressed as a suffix, mirroring common filename extensions, at the end of the URI |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET JSON document that includes technical properties about the full image. It may also contain rights information, and services related to the image.
/api/IIIFv3/v1.0/ImageInfo
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the requested image |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
IdTranslate
GET API getting friendly readable names from a list of SystemIDs.
/api/IdTranslate/v1.0/SystemId
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Import (19)
POST API to upload a file and create a tempfile record in the system Store a cache in cache server with key TargetFolderID_FileName and value is the tempfile path The cache will be expired after 2 hour
/webapi/mediafile/import/upload/uploadlocalandstoreincache_4RP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST API to upload misc file into the system and return the download the file record ID
/webapi/mediafile/import/upload/uploadmisc_4MA_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Check the existence of multiple files in a specific folder
/webapi/mediafile/import/upload/item/checkMultiFilesExistence_4b2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the folder to search in |
|
|
Serialized list of tuples/arrays of the form (fileName, fileSize) |
|
|
Determining whether to return the identifiers of the existing files instead of record IDs |
POST Create a new upload transaction
/webapi/mediafile/import/upload/transaction/24_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Id of target forlder to upload to |
|
|
Should folder structure be preserved during upload
|
|
|
Optional id of the mapping template to use during following import |
|
|
Bolean to indicate that we don't want to include a specific mapping template to this transaction IF THERE HAS BEEN NO _sMappingTemplateRecordID passed in.
|
|
|
[Optional]: Clearance level for items uploaded under this transaction |
|
|
Enforce indicating if the system should LOOK FOR and update an existing database entry if the uploaded item matches |
|
|
Upload method enum |
|
|
Use a cached transaction if available |
|
|
Use HasAccessRight_Fast |
GET Get AWS S3 Presigned URL to upload a file chunk
/webapi/mediafile/import/upload/item/gets3presignedurl_4DA_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UploadItemID |
|
|
Total file length |
|
|
Part size |
|
|
(Optional) Specific part numbers to fetch.
|
|
|
Use accelerated endpoint |
|
|
N/A |
POST Get available domains of the site that are required to be used for domain sharding in the web upload workflow but remain to be bound to be served (a ping API returns 404)
/webapi/mediafile/import/upload/admin/registerDomains_2N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get available domains of the site that can be used for domain sharding in the web upload workflow.
/webapi/mediafile/import/upload/admin/domains_28_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get available domains of the site that have CNAME defined but are not being bound (a ping API returns 404)
/webapi/mediafile/import/upload/admin/unboundDomains_2M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Get meta data from document record id
/webapi/mediafile/metadata/getmeta_418_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the Document. It can be document encrypted RecordID, RecordID or Identifier |
|
|
The format of the extracted metadata |
POST Get meta data from document record id
/webapi/mediafile/import/upload/uploadmediawithurl_45L_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the folder to upload the asset to |
|
|
The file URL to upload |
|
|
Name of the file being uploaded. If not provided, system will try to deduced it from the the response Content-Disposition header or the file URL |
|
|
The media upload mode |
POST Get the position in queue of a UI
/webapi/mediafile/import/upload/queue/position/get_ui_position_in_queue_23m_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The UI RecordID (Only for Log purpose) |
|
|
The UI Enqueue Time |
|
|
The UI QueueID |
|
|
The UI Status |
POST Get the position in queue of a UT
/webapi/mediafile/import/upload/queue/position/get_ut_position_in_queue_23n_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The UT RecordID |
POST Mark an upload item as complete
/webapi/mediafile/import/upload/item/complete_27_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Upload item Id |
|
|
File Digitized Date |
|
|
File Creation Date (UTC) |
|
|
File Last Modified Date (UTC) |
|
|
ETags received from S3 multipart upload requests,
|
POST Mark an upload item as complete
/webapi/mediafile/import/upload/item/markItemsFileMissing_213_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
List of recordids that will be marked as File not found status |
|
|
RecordID of the upload transaction |
POST Register upload items on a previously created upload transaction
/webapi/mediafile/import/upload/item/register_25_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Identifier of the upload transaction this request is for |
|
|
The parent folder of the files to upload, if known |
|
|
Name of the uploader being used to provide more info
|
|
|
Skip validity check
|
|
|
Update UT for incomplete UI upload
|
|
|
Identifier of calling client |
|
|
True if this upload can use a cloud bucket as buffer
|
POST This API allows users to upload one or more files to a folder at the same time
/webapi/mediafile/import/upload/uploadmedia_4az_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the folder to upload the files to |
|
|
Your multiples files |
|
|
True: Creates an asset record and delegates metadata import and proxy file generation to the agent after the call completes. Subsequent API calls can update the asset record.
|
POST Upload a file chunk
/webapi/mediafile/import/upload/item/26_v1/{uploadItemId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Upload Item id |
|
|
Chunk start offset |
|
|
Chunk end offset |
|
|
Total file length |
|
|
Chunk MD5 hash |
|
|
1-base part number for cloud upload, required if using cloud buffer bucket |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
File chunck |
POST Upload an image asset and return the download link to the largest asset format
/webapi/mediafile/import/upload/uploadimageandgetlargestdownloadlink_4CM_v1
In this API, input are passed through form data in the body. Input
-
folderRecordID: the folder recordID we want to upload the asset to
-
files: Your uploading image asset
-
clientFileName: the file name we want to ingest in the client
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Upload file from source bucket
/webapi/mediafile/import/upload/uploadFileFromCloudStorage_4OY_v1
1. Folder content locking is not enforced by this endpoint.
2. Only support 2 duplicate detection mode: Off or Match all.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the existing document, if we want to upload new version.
|
|
|
Record ID of the folder to upload the file to.
|
|
|
Name of the source bucket |
|
|
Object key of the file in the source bucket |
|
|
Name of the file to upload |
|
|
Log info for the upload |
ImportStaff (2)
GET API to allow site admins (having the security StreamImportStaffFeeds) to get an overview of the content of an RDR file based on an input date. This API only streams a limited number of pre-configured fields.
/api/ImportStaff/v1.0/StreamRDRFeed
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A date used to filter RDR input feed. Expected format YYYYmmdd, example: 20200718 |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to import staff users from a CSV file
/api/ImportStaff/v1.0/ImportStaff
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Local path containing the files to import |
|
|
Job name. Used to send email notifications. Optional. |
|
|
Email to send notifications to. Optional. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
InDesignBridge (2)
GET Returns file links for the assets passed in _sIdentifiers argument
/api/InDesignBridge/v1.0/GetFileLinks
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Object identifiers |
|
|
Optional object identifier to the relink date (UTC) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns file stamps (File Import Dates) for the images passed in _sIdentifiers argument. Used in InDesign to know if we should download new file version
/api/InDesignBridge/v1.0/GetFileStamps
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Image identifiers to get stamp and status |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
InDesignServer (5)
GET API endpoint for fixing the links of InDesign template documents and recompute their representative
/api/InDesignServer/v1.0/UpdateDocsLinks
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template identifiers, separated by a comma. Leave blank to process all te templates in existence |
|
|
Force relink regardless of the link status. By default only relink in case of modified links |
|
|
Force recompute representative. By default only recompute in case of modified links |
|
|
Batch process size |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint for for checking whether Adobe InDesign Server is properly licensed
/api/InDesignServer/v1.0/VerifyLicense
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint for getting all available fonts from Indesign server
/api/InDesignServer/v1.0/GetApplicationFonts
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
InDesign fonts are cached for 2 hours after fetching. Would you like to refresh the value in the cache now? |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint for getting all available fonts in template
/api/InDesignServer/v1.0/GetIndesignTemplateFonts
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template id |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint for health checking InDesign server instances
/api/InDesignServer/v1.0/HealthCheck
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
addresses |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Indexing (4)
GET Get if a field / facet category index is expired or not. NOTE: the result may be delayed due to cache.
/webapi/search/indexing/indexingfieldStatus/getisexpired_468_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Api names:
Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FacetCategories. Facet categories indexing statuses won't be included if filling both fields. |
|
|
Codes of facet categories (or tag categories) Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FieldApiNames. Facet categories indexing statuses won't be included if filling both fields. |
|
|
N/A |
GET Get indexing status of a field or facet category. NOTE: the result may be delayed due to cache.
/webapi/search/indexing/indexingfieldStatus/get_45E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Api names:
Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FacetCategories. Facet categories indexing statuses won't be included if filling both fields. |
|
|
Codes of facet categories (or tag categories) Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FieldApiNames. Facet categories indexing statuses won't be included if filling both fields. |
|
|
N/A |
GET Get the estimate (from now) that a field / facet category will be fully indexed. NOTE: the result may be delayed due to cache.
/webapi/search/indexing/indexingfieldStatus/getestimatedcompletionfromnow_467_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Api names:
Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FacetCategories. Facet categories indexing statuses won't be included if filling both fields. |
|
|
Codes of facet categories (or tag categories) Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FieldApiNames. Facet categories indexing statuses won't be included if filling both fields. |
|
|
N/A |
POST Reactivate an expired index of fields / facet categories.
/webapi/search/indexing/indexingfieldStatus/reactivateexpiredindices_469_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Api names:
Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FacetCategories. Facet categories indexing statuses won't be included if filling both fields. |
|
|
Codes of facet categories (or tag categories) Only fill this or OrangeLogic.WebApi.Controller.Search.Indexing.GetIndexingFieldStatusApiRequest.FieldApiNames. Facet categories indexing statuses won't be included if filling both fields. |
Integrations (96)
POST A more specific method that wraps around the SignViaDocuSign method specifically for the Wayfair - DocuSign integration: https://link.orangelogic.com/Tasks/22YJW6
/webapi/extensibility/integrations/docusign/signcampagingsorting_4E5
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The recordID of the asset that will be signed via DocuSign. |
|
|
Folder (mother) of the asset RID. Required if siging via email. |
|
|
The Format of the asset that will be signed via DocuSign. |
|
|
The title of the asset if leave empty, will fallback to original filename. |
|
|
Flag to decide whether to sign immediately or later via an email. |
|
|
N/A |
POST Authenticate with refresh token
/webapi/extensibility/integrations/adobe/authorization/authenticate_21H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
the refresh token, obtained by calling Authorize endpoint previously |
|
|
the request nonce |
|
|
List of suported external applications |
POST Cancel a scheduled batch recognition job. If the job is on-going, the remaining assets will be cancelled.
/webapi/extensibility/integrations/facialrecognition/cancelbatchrecognition_43T_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Transaction ID of the processing if available |
|
|
RecordID of the fodler |
GET Check for assets availability against a list of record IDs or Identifiers
/webapi/extensibility/integrations/adobe/premiere/VerifyListOfDocumentsAvailability_4B9_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List/array of document record IDs OR identifiers to verify |
|
|
N/A |
GET Check if the current user has the specified permission
/webapi/extensibility/integrations/figma/upload/hasuploadaccess_47A_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the object to check upload access |
|
|
N/A |
GET Check the status of a scheduled batch recognition job
/webapi/extensibility/integrations/facialrecognition/getbatchrecognitionstatus_43U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Transaction ID of the processing if available |
|
|
RecordID of the fodler |
|
|
Fetch the list of successfully indexed items |
|
|
N/A |
POST Create a bucket in Autodesk Platform Services (APS) Object Storage Service (OSS)
/webapi/integrations/archivesspace/syncdigitalobject_4gu_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the Digital Object's counterpart in Orange DAM |
POST Create a new file from a container for a specific Adobe application
/webapi/extensibility/integrations/adobe/createfilefromcontainer_4AX_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Document type (copied from DO_DOCUMENTS_TBO as referencing outside Contract DLL is not allowed) |
|
|
Document record ID of the container |
|
|
The target Adobe application ID to create the file. Supported applications:
|
|
|
The version of the target Adobe application. Can be the version or the release year.
|
|
|
Title, will be used as the name of the file to be created |
|
|
Auto-import child assets of the container when opening the file in the selected Adobe application |
POST Create a record representing a Cortex facial person The newly created person will be qualified as Unknown initially
/webapi/extensibility/integrations/facialrecognition/createperson_43H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Filepath to the image representing the avatar for the person |
|
|
ID of the image representing the avatar for the person
|
|
|
FaceID in the external system, representing the avatar of the person
|
|
|
Different state of facial recognition to an asset |
|
|
Whether to train the group after creation |
POST Endpoint for OneDrive webhook to notify Cortex about changes
/webapi/extensibility/integrations/onedrive/notify_492_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Endpoint to check the health of the InDesign Transformation Service (ITS)
/webapi/extensibility/integrations/adobe/indesign/checkitshealth_4w5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Endpoint to create a new chatgpt conversation and returns its id
/webapi/extensibility/integrations/openai/initconversation_4b3_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Id of the bot profile to generate the context for |
|
|
This will be used with the contexts that need to know a list of assets |
|
|
Conversation purpose |
|
|
N/A |
POST Endpoint to reset the last sync date for the getty syncing process.
/webapi/extensibility/integrations/getty/resetlastsyncdate_4BA_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the sync folder (can be Encrypted ID, Identifier, RecordID) |
|
|
N/A |
GET Fetch list of all people tagged in the input asset
/webapi/extensibility/integrations/facialrecognition/fetchrecognized_43F_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of asset id to query |
|
|
N/A |
POST Fetch the information about the Cortex facial persons from their list of IDs
/webapi/extensibility/integrations/facialrecognition/retrievepersoninfos_43R_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the the person to be fetched |
|
|
N/A |
GET Generate a download link for the largest downloadable format
/webapi/extensibility/integrations/google/assetbrowser/getdownloadlink_47g_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record ID |
|
|
Max width |
|
|
Max height |
|
|
This link is used in HTML Image tag |
|
|
If we want to get asset link instead of permanent link
|
|
|
N/A |
GET Generate a download link for the largest downloadable format
/webapi/extensibility/integrations/google/assetbrowser/getdownloadlinks_4au_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record IDs |
|
|
Forced used format |
|
|
Links is used in HTML Image tag |
|
|
N/A |
GET Generate a download link for the largest downloadable format
/webapi/extensibility/integrations/gab/assetbrowser/getdownloadlink_4bx_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record ID |
|
|
Max width |
|
|
Max height |
|
|
This link is used in HTML Image tag |
|
|
If we want to get asset link instead of permanent link
|
|
|
N/A |
GET Generate a download link for the largest downloadable format
/webapi/extensibility/integrations/aem/assetbrowser/getdownloadlink_4af_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record ID |
|
|
Max width |
|
|
Max height |
|
|
This link is used in HTML Image tag |
|
|
If we want to get asset link instead of permanent link
|
|
|
N/A |
GET Generate a download links for the largest downloadable format
/webapi/extensibility/integrations/figma/assetbrowser/getdownloadlinks_476_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record IDs |
|
|
Forced used format |
|
|
Links is used in HTML Image tag |
|
|
N/A |
GET Get Text Recognition endpoint
/webapi/extensibility/integrations/transkribus/PerformTextRecognition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The document RecordID |
|
|
Path to the input file on server (image/pdf). !!! This should used by internal process only |
|
|
Should the asset text content be set? !! OrangeLogic.Contracts.Extensibility.Integrations.TextRecognition.RunTextRecognitionRequest.RecordID must be set if this is true |
|
|
Should searchable PDF created
|
|
|
Forced output path for the pdf output |
|
|
Extra configuration for the process. (Serialized) |
|
|
List of all expected languages. !!! Some services may not support multiple languages, we will use the first language in the list. |
|
|
The emails of all the users that need to be notified when the process is done.
|
|
|
N/A |
POST Get access key
/webapi/extensibility/integrations/google/authorization/{context}/getaccesskey_47e_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
This enums defines for what application access key was delivered and is valid |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Request ID |
POST Get access key
/webapi/extensibility/integrations/gab/authorization/getaccesskey_4bv_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Request ID |
POST Get access key
/webapi/extensibility/integrations/figma/authorization/getaccesskey_474_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Request ID |
POST Get access key
/webapi/extensibility/integrations/aem/authorization/getaccesskey_4aj_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Request ID |
POST Get access token
/webapi/extensibility/integrations/templafy/v1/oauth2/token
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Type of the access token, will always “client_credentials” |
|
|
Client ID configured in the Templafy Admin Center.
|
|
|
Client ID configured in the Templafy Admin Center.
|
POST Get access token
/webapi/extensibility/integrations/templafy/GetToken_438_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Type of the access token, will always “client_credentials” |
|
|
Client ID configured in the Templafy Admin Center.
|
|
|
Client ID configured in the Templafy Admin Center.
|
GET Get all available proxies for GAB
/webapi/extensibility/integrations/gab/assetbrowser/AvailableProxies_4ea
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get book information for display The information includes: book basic metadata (title, name, author etc) and the list of pages included inside the book. The list of pages manifested under
/webapi/extensibility/integrations/assetpreview/bookreader/GetBookInfoForDisplay_23A_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Root record ID of the book |
|
|
Indicates if the cover should be returned |
|
|
Starting page number to retrieve |
|
|
Ending page number to retrieve |
|
|
Indicates if the stacked assets should be hidden |
|
|
Indicates if the cache should be refreshed |
|
|
N/A |
GET Get current logged-in user info
/webapi/extensibility/integrations/google/authorization/getuserinfo_47b_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get current logged-in user info
/webapi/extensibility/integrations/gab/authorization/getuserinfo_4bs_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get current logged-in user info
/webapi/extensibility/integrations/figma/authorization/getuserinfo_471_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get current logged-in user info
/webapi/extensibility/integrations/adobe/authorization/GetUserInfo_210_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get current logged-in user info
/webapi/extensibility/integrations/aem/authorization/getuserinfo_4ag_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Get current logged-in user info
/webapi/extensibility/integrations/google/authorization/{context}/getaccesstoken_47c_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
This enums defines for what application access key was delivered and is valid |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
the access key obtained by calling Authorize endpoint previously |
POST Get current logged-in user info
/webapi/extensibility/integrations/gab/authorization/getaccesstoken_4bt_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
the access key obtained by calling Authorize endpoint previously |
POST Get current logged-in user info
/webapi/extensibility/integrations/figma/authorization/getaccesstoken_472_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
the access key obtained by calling Authorize endpoint previously |
POST Get current logged-in user info
/webapi/extensibility/integrations/adobe/authorization/GetToken_2z_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
the request code, obtained by calling Authorize endpoint previously |
|
|
the request nonce |
|
|
List of suported external applications |
POST Get current logged-in user info
/webapi/extensibility/integrations/aem/authorization/getaccesstoken_4ah_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
the access key obtained by calling Authorize endpoint previously |
GET Get direct descendant folders
/webapi/extensibility/integrations/templafy/v1/folders
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parent folder Unique Identifier (Ex: [parent identifier]/[child identifier] like 'A-IKVJ/ASDA35').
|
|
|
The templafy user's email in the request's "x-templafyuser" header.
|
|
|
N/A |
GET Get direct descendant folders
/webapi/extensibility/integrations/templafy/GetFolders_439_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parent folder Unique Identifier (Ex: [parent identifier]/[child identifier] like 'A-IKVJ/ASDA35').
|
|
|
The templafy user's email in the request's "x-templafyuser" header.
|
|
|
N/A |
GET Get direct descendant images
/webapi/extensibility/integrations/templafy/v1/images
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parent folders Unique Identifier separated by '/' (Ex: [parent identifier]/[child identifier] like 'A-IKVJ/ASDA35').
|
|
|
Search query passed along from the Templafy interface. Can be used to for instance filter images on name and tags |
|
|
Page number of a paginated result that is being requested |
|
|
Size of returned paginated results |
|
|
The templafy user's email in the request's "x-templafyuser" header.
|
|
|
N/A |
GET Get direct descendant images
/webapi/extensibility/integrations/templafy/GetImages_43A_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parent folders Unique Identifier separated by '/' (Ex: [parent identifier]/[child identifier] like 'A-IKVJ/ASDA35').
|
|
|
Search query passed along from the Templafy interface. Can be used to for instance filter images on name and tags |
|
|
Page number of a paginated result that is being requested |
|
|
Size of returned paginated results |
|
|
The templafy user's email in the request's "x-templafyuser" header.
|
|
|
N/A |
GET Get image download link
/webapi/extensibility/integrations/templafy/v1/images/{assetID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get image download link
/webapi/extensibility/integrations/templafy/GetImageDownloadUrl_43B_v1/{assetID}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get information from the filter criterion table
/webapi/extensibility/integrations/drupal/getdrupalfiltercriterion_46V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the asset link for AEM
/webapi/extensibility/integrations/adobe/aem/GetAssetLink_4a9
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the asset |
|
|
N/A |
GET Get the asset link for Generic Asset Browser
/webapi/extensibility/integrations/gab/assetbrowser/GetAssetLink_4by
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the asset |
|
|
The proxy to use when generating the link.
|
|
|
Extra metadata field to get when generating the link |
|
|
N/A |
GET Get the format map to the document type
/webapi/extensibility/integrations/drupal/getformat_46U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Given a person and a list of assets in which the person is known to be tagged, this endpoint allows to validate the tag suggesions (to have the status Confirmed)
/webapi/extensibility/integrations/facialrecognition/confirmpersoninassets_43N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the Cortex person |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
|
|
N/A |
GET Given a person, this endpoint allows to fetch the list of assets in which the input person should be ignored
/webapi/extensibility/integrations/facialrecognition/fetchassetspersonshouldbeignored_44U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the person to query |
|
|
Maximum number of items fetched |
|
|
N/A |
POST Given an image asset, this endpoint removes all facial tags that were made
/webapi/extensibility/integrations/facialrecognition/removefacesfromasset_43P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the asset to remvoe faces from |
|
|
If set, skip updating the process state to Cancelled |
|
|
N/A |
POST Import data from CSV file to temporary table in DB
/webapi/objectmanagement/DFMigration/importcsv_4eo_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Parameter name to store the import configuration, Must be inhertied from DF_ThirdPartyMetadataGatheringTool_BO, Example: DF_CollectionAssetsCSVGatheringTool_BO/DF_CollectionAssetsCSVGatheringTool_BO |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input file |
GET List people by their name. Given a person name, fetch the list of people whose name matches exactly (case-insensitve)
/webapi/extensibility/integrations/facialrecognition/listpeople_43G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Person name |
|
|
N/A |
GET Map tag name to Highspot's list ID
/webapi/extensibility/integrations/highspot/maptagtolistid_4eb
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of the spot that the asset will be push from Cortex to Highspot |
|
|
The ID of the asset that will be push from Cortex to Highspot |
|
|
N/A |
POST Merge 2 Cortex people The faces of the source person will be added to the target person The source person will cease to exist after the merge.
/webapi/extensibility/integrations/facialrecognition/merge2people_43L_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the record represetning source person of the merge |
|
|
RecordID of the record represetning target person of the merge |
POST Perform facial recogntion task on a set of assets. It detect potential faces from those assets.For each face, check to see if the faces belong to a person and auto assign to that person whenever the confidence level exceeds a certain threshold
/webapi/extensibility/integrations/facialrecognition/recognize_43E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
List of assets to detect / recognize |
GET Perform search for terms in the book
/webapi/extensibility/integrations/assetpreview/bookreader/search_23B_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the book |
|
|
Query terms |
|
|
Name |
|
|
Query terms |
|
|
Name |
|
|
N/A |
POST Perform text to speech and save voice
/webapi/extensibility/integrations/texttospeech/texttospeechsavevoice_4m6_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Record ID of original asset version |
|
|
File name |
|
|
Represents a text to speech provider |
GET Perform text to speech to preview
/webapi/extensibility/integrations/texttospeech/texttospeechpreview_4m8_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Text to speech provider to use |
|
|
SSML text |
|
|
Language code |
|
|
Voice name |
|
|
Voice gender |
|
|
N/A |
GET Register to pull the entire space structure from Wrike. Skip any items that are already pulled.
/webapi/extensibility/integrations/wrike/space/pullstructure_4am_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Wrike Space ID |
|
|
Record ID of the corresponding folder in Cortex |
|
|
N/A |
POST Register to pull the entire space structure from Wrike. Skip any items that are already pulled.
/webapi/extensibility/integrations/wrike/space/pullstructure_4am_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Wrike Space ID |
|
|
Record ID of the corresponding folder in Cortex |
|
|
N/A |
POST Remove a facial suggestion (i.e a link between an image and a person that is tagged in that image)
/webapi/extensibility/integrations/facialrecognition/removepersonfromasset_43Q_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
|
|
N/A |
DELETE Remove an existing Cortex facial person
/webapi/extensibility/integrations/facialrecognition/removeperson_43I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the person to be removed |
|
|
Whether to remove also associated facial information? |
POST Remove an existing Cortex facial person
/webapi/extensibility/integrations/facialrecognition/removeperson_43I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the person to be removed |
|
|
Whether to remove also associated facial information? |
POST Remove the input the facial suggestion (i.e a link between an image and a person that is tagged in that image). The suggestions are deemed incorrect.
/webapi/extensibility/integrations/facialrecognition/rejectpersonfromasset_43V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
|
|
N/A |
GET Request authorization
/webapi/extensibility/integrations/gab/authorization/requestauthorize_4bu_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
GET Request authorization
/webapi/extensibility/integrations/figma/authorization/requestauthorize_473_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
GET Request authorization
/webapi/extensibility/integrations/aem/authorization/requestauthorize_4ai_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
POST Request authorization
/webapi/extensibility/integrations/gab/authorization/requestauthorize_4bu_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
POST Request authorization
/webapi/extensibility/integrations/figma/authorization/requestauthorize_473_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
POST Request authorization
/webapi/extensibility/integrations/aem/authorization/requestauthorize_4ai_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
POST Request authorization with a context
/webapi/extensibility/integrations/google/authorization/{context}/requestauthorize_47d_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The request nonce |
GET Retrieve children of the requested container
/webapi/extensibility/integrations/google/assetbrowser/getcontent_47f_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
While resolving value for OrangeLogic.Contracts.ObjectManagement.Relations.RelatedAsset.GetContentRequest.Fields, we get some extra fields that are not requested. This option will remove those extra fields from the result when set to true. |
|
|
List of subtype criteria.
Images Containers>>Virtual folders ... |
|
|
Additional filter with Cortex Search API syntax.
Text:Contain this text |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
N/A |
GET Retrieve children of the requested container
/webapi/extensibility/integrations/gab/assetbrowser/getcontent_4bw_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
While resolving value for OrangeLogic.Contracts.ObjectManagement.Relations.RelatedAsset.GetContentRequest.Fields, we get some extra fields that are not requested. This option will remove those extra fields from the result when set to true. |
|
|
List of subtype criteria.
Images Containers>>Virtual folders ... |
|
|
Additional filter with Cortex Search API syntax.
Text:Contain this text |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
N/A |
GET Retrieve children of the requested container
/webapi/extensibility/integrations/figma/assetbrowser/getcontent_475_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
While resolving value for OrangeLogic.Contracts.ObjectManagement.Relations.RelatedAsset.GetContentRequest.Fields, we get some extra fields that are not requested. This option will remove those extra fields from the result when set to true. |
|
|
List of subtype criteria.
Images Containers>>Virtual folders ... |
|
|
Additional filter with Cortex Search API syntax.
Text:Contain this text |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
N/A |
GET Retrieve children of the requested container
/webapi/extensibility/integrations/workfront/validatefieldsmapping_4EN_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve children of the requested container
/webapi/extensibility/integrations/aem/assetbrowser/getcontent_4ae_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
While resolving value for OrangeLogic.Contracts.ObjectManagement.Relations.RelatedAsset.GetContentRequest.Fields, we get some extra fields that are not requested. This option will remove those extra fields from the result when set to true. |
|
|
List of subtype criteria.
Images Containers>>Virtual folders ... |
|
|
Additional filter with Cortex Search API syntax.
Text:Contain this text |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
N/A |
GET Retrieve fields of the requested object
/webapi/extensibility/integrations/figma/assetbrowser/getfields_4AK_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
N/A |
GET Retrieve the uploaded document info from the upload item
/webapi/extensibility/integrations/adobe/premiere/getuploadeddocumentinfo_493_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of target upload item record IDs |
|
|
N/A |
GET Return list of supported voices for Text To Speech
/webapi/extensibility/integrations/texttospeech/getvoiceslist_4m5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language code |
|
|
True means only return voices that support SSML, otherwise return all voices |
|
|
Text to speech provider to use |
|
|
N/A |
POST Schedule a batch facial recognition job given a container ID and a list of selected assets in that container. The selected assets must be descendants of the root container
/webapi/extensibility/integrations/facialrecognition/schedulebatchrecognition_43S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Root container ID |
|
|
RecordID of the requestor |
|
|
Email of the requestor |
|
|
Explicite set of assets ids |
POST Share the document via Signiant
/webapi/extensibility/integrations/signiant/share/4h_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
If true, the hierarchy will be expanded to include all assets in the hierarchy |
|
|
Expiration date of the share |
|
|
Email addresses which we want to share to |
|
|
The format that being used for all images.
|
|
|
The format that being used for all audios.
|
|
|
The format that being used for all videos.
|
|
|
The email subject for the share |
|
|
The email body for the share that contain the Signiant link |
POST Sign a document via DocuSign with two flow: via email or redirect to DocuSign's Recipient View
/webapi/extensibility/integrations/docusign/sign_4E4
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The recordID of the asset that will be signed via DocuSign. |
|
|
The Format of the asset that will be signed via DocuSign. |
|
|
The title of the asset if leave empty, will fallback to original filename. |
|
|
Flag to decide whether to sign immediately or later via an email. |
|
|
Callback URL that DocuSign will call after the user has signed the document. |
|
|
By default the webhook request from DocuSign will include the content of the signed document as xml data. If this flag is set to false, the webhook request will not include the signed document |
|
|
By default the webhook request from DocuSign will include the content of the certificate of completion as xml data. If this flag is set to false, the webhook request will not include the certificate |
|
|
N/A |
GET Sync Axiell assets with cortex
/webapi/extensibility/integrations/axiell/syncasset_4al
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Priref M:OrangeLogic.Contracts.Extensibility.Integrations.Axiell.IAxiellService.SyncAsset(OrangeLogic.Contracts.Extensibility.Integrations.Axiell.SyncAssetRequest) |
|
|
The Cortex Record ID M:OrangeLogic.Contracts.Extensibility.Integrations.Axiell.IAxiellService.SyncAsset(OrangeLogic.Contracts.Extensibility.Integrations.Axiell.SyncAssetRequest) |
|
|
The Doctype of the Asset |
|
|
N/A |
POST The API that DocuSign will call to after the user has signed the document via the email flow. DocuSign -> email singing request -> sign -> this API.
/webapi/extensibility/integrations/docusign/campaignsortingcallback_4E6
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Release doc info data. Encrypted. |
|
|
Folder (mother) of the asset RID. Required if siging via email. |
|
|
Original filename. |
|
|
Title of the asset. |
|
|
N/A |
GET This endpoint allow to retrieve the facial recognition processing state for each asset passed in the parameter
/webapi/extensibility/integrations/facialrecognition/fetchcurrentstate_43W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset IDs |
|
|
N/A |
POST This endpoint allows to ignore a person in a list of photos Previously tags of this person in specified assets will be ignored in search results
/webapi/extensibility/integrations/facialrecognition/ignorepersoninassets_44P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the Cortex person |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
POST This endpoint allows to ignore persons from a list of the suggestions. In each of these suggetion, the associated person will be ignored in the associated
/webapi/extensibility/integrations/facialrecognition/ignorepersonfromsuggestions_44S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the suggestion (i.e. link between the person and the photo asset) |
POST This endpoint allows to unignore (reverse the ignored status) of a person in a list of photos Previously tags of this person in specified assets will start to appear in search results
/webapi/extensibility/integrations/facialrecognition/unignorepersoninassets_44T_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
POST Update a Cortex person using the information passed in the request
/webapi/extensibility/integrations/facialrecognition/updateperson_43J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
ID of the person to be updated |
|
|
RecordID of the thumbnail of the person in Corrtwex |
|
|
Different state of facial recognition to an asset |
POST Update the representative of a person from a tagged image. The person must be tagged in the linked document first.
/webapi/extensibility/integrations/facialrecognition/updaterepresentativefromsource_43K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the person to be updated |
|
|
ID of the asset located |
POST Update the status of a machine confirmation to be Confirmed This is use to validate the correctness from the algorithm suggestion
/webapi/extensibility/integrations/facialrecognition/confirmfacesuggestion_43M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
|
|
N/A |
POST Update the status of a machine confirmation to be Unconfirmed This is use to revert the confirmation of a suggestio from the algorithm suggestion
/webapi/extensibility/integrations/facialrecognition/unconfirmfacesuggestion_43O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the suggestion (i.e.link between the face and the asset) |
|
|
N/A |
POST Upload a binary from Lightroom Classic plugin, along with tags and description
/webapi/extensibility/integrations/adobe/lightroom/Upload_211_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
image binary |
POST Upload a new asset or create a new version of a figma file to Cortex based on its figma ID
/webapi/extensibility/integrations/figma/upload/uploadorcreatenewversion_470_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the parent folder to upload to |
|
|
The file name with extension |
|
|
URL to the figma file |
|
|
Title of the created document |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to upload |
KeywordSuggester_BO
GET Suggest keywords for an asset
/api/KeywordSuggester_BO/1.0/SuggestKeywords
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
JSON serialized parameters. Supported keys: ComputeAdvancedTags, ComputeLogoDetection, AddRemovedLinks |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Keywords (2)
GET An API to extract keywords.
/api/Keywords/v1.0/ExtractKeywords
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of document to extract keywords from |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Assign keywords for the given document.
/api/Keywords/v1.0/AssignKeywords
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of document to extract keywords from |
|
|
Default KeyTypes to search for Keywords |
|
|
Default KeyType to create new Keyword if couldn not find in the KeyType list |
|
|
The JSON presentation list of Keywords to assign |
|
|
Language (optional) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
KeywordsToReplace
GET Schedule a tag replacement
/api/KeywordsToReplace/v1.0/ScheduleReplacement
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the tag to replace |
|
|
RecordID of the tag to keep |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
LIGHTBOX (4)
GET Add a document to a lightbox. The document will be placed in last position. If the document is already present the call will return SUCCESS and the document will remain at its current position.
/api/LIGHTBOX/1.2/AddToLightbox
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Unique identifier of the lightbox. |
|
|
Unique identifier of the document to add. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET List all the contacts that can access a ligthbox.
/api/LIGHTBOX/v1.0/LightboxListShares
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Unique identifier of the lightbox. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Lists all the documents contained in a lightbox and returns their identifier and title.
/api/LIGHTBOX/v1.0/LightboxListContent
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Unique identifier of the lightbox. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Removes a document from a lightbox. Return SUCCESS only if the document is present and the removal successful.
/api/LIGHTBOX/1.2/RemoveFromLightbox
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Unique identifier of the lightbox. |
|
|
Unique identifier of the document to remove. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Ledger (4)
POST Commit a transaction
/webapi/invisiblehand/ledger/committransaction_41D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Source name
|
|
|
The ID of source |
|
|
The amount of transaction |
|
|
The currency code of amount.
|
|
|
Transaction action type when commiting transactions |
GET Get all transactions for sources
/webapi/invisiblehand/ledger/gettransactions_41F_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The source name which hold transactions
|
|
|
The ID of sources which hold transactions |
|
|
If filled, only the transaction with same currency is returned |
|
|
To exclude all references transaction (e.g: transfer from pools to objects) |
|
|
If filled, only the transaction with same Type is returned |
|
|
The Name of target |
|
|
The ID of target |
|
|
N/A |
GET Get current credit balance of sources
/webapi/invisiblehand/ledger/getcreditbalance_41E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The source name which hold transactions
|
|
|
The ID of sources which hold transactions in order to process. |
|
|
The user ID to retrieve detailed transactions status. If empty, the service will return zero as UserCredits |
|
|
The currency code of amount.
|
|
|
N/A |
GET Get latest transaction of sources
/webapi/invisiblehand/ledger/getlatesttransaction_21J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The source name which hold transactions
|
|
|
The ID of sources which hold transactions |
|
|
Currency code to fetch transactions |
|
|
The type of transaction to include |
|
|
N/A |
Localization (3)
GET Execute special actions after all validations are called for a localized audio
/webapi/objectmanagement/localization/audio/executepostvalidationaction_4A1_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of localized audio. Can be RecordID/Encrypted RecordID/Identifier |
|
|
N/A |
POST Localize a list of audio
/webapi/objectmanagement/localization/audio/localize_49W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Can be either identifiers, record ID or encrypted record ID of assets |
GET Perform validating localized audio on a single criterion
/webapi/objectmanagement/localization/audio/validatemetadata_49Z_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of localized audio. Can be RecordID/Encrypted RecordID/Identifier |
|
|
Criterion to perform validation on |
|
|
Comparison mode |
|
|
Specifies the scope for performing comparisons |
|
|
N/A |
Log
GET An API to log errors to server from client applications
/api/Log/v1.0/AddLog
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Log level |
|
|
Name of application that is calling this API |
|
|
Application Version |
|
|
Log Message |
|
|
Exception text including stacktrace if it exists |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
MailChimpWebHooks
GET Mailchimp APIv3 list Webhook Callback for syncrhonizing with Mailchimp subscribe/unsubscribe to a list
/api/MailChimpWebHooks/v1.0/MailChimpListCallback
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Encrypted value of the MailChimp Mailing List's unqiue Id |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Measurement (2)
GET Fetch multipliers
/webapi/invisiblehand/measurement/fetchmultipliers_41J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Get multiplier items
/webapi/invisiblehand/measurement/getmultipliers_44D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of users or groups
|
MediaFile
POST Get the assets cloud file key
/webapi/mediafile/assetpath/getassetcloudfilekey_4AT_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Media_DbBO (7)
GET Fix documents which are not marked as digitized, but have been moved to a permanent location.
/api/Media_DbBO/v1.0/FixUndigitizedDocuments
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Populate EncryptedFileSize and EncryptedFileMD5 for encrypted documents
/api/Media_DbBO/v1.0/PopulateEncryptedFileData
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Populate FileImportDates for digitized documents
/api/Media_DbBO/v1.0/PopulateFileImportDate
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Regenerate proxies and inject IPTC to list of formats
/api/Media_DbBO/v1.0/InjectIPTCFormats
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target Record ID |
|
|
Format to inject. Can be a "|" separated list (example: 'format1|format2|format3') |
|
|
Run in background |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Regenerate proxies for one or multiple assets. Requires access to security point: RecomputeMedia
/api/Media_DbBO/v1.0/RegenerateProxiesForAsset
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifier of the asset to regenerate proxies for. Can be set to '*' to recompute all assets. Can be set to a CSV list of identifiers (example: 'ID1,ID2,ID3'). Can be set to 'temptable' to use temp table for target Identifiers |
|
|
Format to recompute. Can be a "|" separated list (example: 'format1|format2|format3'). If not specified or none formats were included in the asset 's FormatsPolicy (if exist), the API will recompute all formats |
|
|
Must be specified if the FileFormat parameter is specified |
|
|
Priority of the recomputation async tasks. If not specified, the API will use a default priority that is very low |
|
|
TheFormatExists: the format is re-generated only for the assets for which it already exists \n TheFormatDoesntExist: the format is generated only for the assets for which it doesn't already exist,If not specified we generate for all assets (if the format already exists it will be overwritten).Supported only for audio and videos. Not supported for images. |
|
|
Force re-generating the representative even if the asset already has one |
|
|
Optional: any explanation or comment on this recomputation. This will be stored in the async transaction description. |
|
|
Optional: Additional SQL Condition to select the assets to recompute. For Orange Logic only. |
|
|
Optional: The temporary table name in which we stored document identifiers to proceed |
|
|
Optional: true to re-extract the media data and update it in database before generating the proxies.For images: media data is width and height. For videos: width, height, duration, bit rates, frame rate, formats... For audio: duration, bit rate, format...This parameter is useful when the media data is not correct in database (due to an ingest issue for example) and allows correcting it before regenerating the proxies. |
|
|
Optional: An asynchronous transaction record ID can be specified. Async tasks will be part of the specified transaction. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Restore a previous version of an image
/api/Media_DbBO/v1.0/RestoreVersion
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The Record ID/Encrypted RecordID/ Identifier of the document |
|
|
The version number of the original document to restore |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Update requested encryption for encrypted documents
/api/Media_DbBO/v1.0/UpdateRequestedEncryption
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
MeetingAgenda
GET API to add a project to a meeting
/api/MeetingAgenda/v1.0/AddToMeeting
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
MeetingReport
GET Generate Meeting Report
/api/MeetingReport/v1.0/Generate
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specific file name for the report |
|
|
Download directly |
|
|
Report version name |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Metadata (40)
POST Add template to a subtype
/webapi/objectmanagement/metadata/texttemplate/addtosubtype_id_4BM_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Template ID |
|
|
Object subtype
|
POST Add template to a subtype
/webapi/objectmanagement/metadata/texttemplate/addtosubtype_code_lang_4BN_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Template Code |
|
|
Template language |
|
|
Object subtype
|
PATCH Changes the document type of the specified documents.
/webapi/objectmanagement/metadata/doctype/changedocumentdoctype_4l8_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document identifier. Can be encrypted record ID/record ID/Identifier. |
|
|
New document type to be assigned. |
|
|
N/A |
POST Create new template
/webapi/objectmanagement/metadata/texttemplate/create_4BD_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Language used in the template |
|
|
User-friendly name of the template |
|
|
Verbose description about information provided by the template |
|
|
Content of the template |
POST Create or update field
/webapi/objectmanagement/metadata/fields/4DD_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
DbBO to create the field |
|
|
Table to create the field |
|
|
Specifies whether to clear the cache in the background or foreground.
|
POST Create or update subtype node
/webapi/objectmanagement/metadata/subtypes/4DJ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete an existing template
/webapi/objectmanagement/metadata/texttemplate/delete_by_id_4BK_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template system ID |
|
|
N/A |
DELETE Delete an existing template
/webapi/objectmanagement/metadata/texttemplate/delete_by_code_lang_4BL_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template Code |
|
|
Template Language |
|
|
N/A |
GET Get Field node from Id
/webapi/objectmanagement/metadata/fields/4DD_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Table name (e.g. DO_DOCUMENTS) |
|
|
DbBO Name |
|
|
Field ID |
|
|
N/A |
GET Get Key Type Groups
/webapi/objectmanagement/metadata/fields/getkeytypegroups_4DI_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get Key Types
/webapi/objectmanagement/metadata/fields/getkeytypes_4DH_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get SubTypes under the DO_DOCUMENTS section, along with a wildcard entry for each Type A wildcard stands for all subtypes of a Type
/webapi/objectmanagement/metadata/doctype/subtypeswithwildcard_4A5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Include an entry representing all types
|
|
|
N/A |
GET Get Subtype node details
/webapi/objectmanagement/metadata/subtypes/4DJ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Table name of the subtype |
|
|
DbBO name of the subtype |
|
|
Subtype ID |
|
|
N/A |
GET Get Subtype node details
/webapi/objectmanagement/metadata/subtypes/getall_4DS_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Table to get all subtype nodes |
|
|
N/A |
POST Get Subtype node details
/webapi/objectmanagement/metadata/subtypes/validate_4DT_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The table name, default is DO_DOCUMENTS |
GET Get a version change information of a document field We will get information based on the change recordID
/webapi/objectmanagement/metadata/versioning/assetversioning/get_asset_field_version_4AV_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the asset we want to get |
|
|
Record ID of change to the field in table TV_TABLEVERSIONING |
|
|
One ChangeRecordID can indicate either an added or removed record based on the value of changeAction.
|
|
|
N/A |
GET Get all alias fields in system
/webapi/objectmanagement/metadata/fields/getallaliasfields_4C3_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all dbbos
/webapi/objectmanagement/metadata/subtypes/getalldbbos_4DK_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all fields visible to the current user
/webapi/objectmanagement/metadata/fields/getallobjectfieldsforcurrentuser_4C2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all fields visible to the current user
/webapi/objectmanagement/metadata/fields/getallobjectfieldsforcurrentuser_4C2_v2
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all searchable fields visible to the current user
/webapi/objectmanagement/metadata/fields/getallsearchablefieldsforcurrentuser_241_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all templates in the system
/webapi/objectmanagement/metadata/texttemplate/getall_4BG_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all text templates linked to an Object Subtype
/webapi/objectmanagement/metadata/texttemplate/getinsubtype_4BH_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Object subtype
|
|
|
N/A |
GET Get all version change of a document field We will get it in patch but also get the total number of version
/webapi/objectmanagement/metadata/versioning/assetversioning/get_asset_versioning_49U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record id of asset |
|
|
Identifier of asset |
|
|
The field name we want to get changes
|
|
|
This indicates the starting record we want to get. In a way you can see it as the number of newest changes we skip getting.
|
|
|
This indicates how many record we want to get. This will be used in conjunction with "Start".
|
|
|
Should we also return the field content or not,
|
|
|
N/A |
GET Get all version of requested assets
/webapi/objectmanagement/metadata/versioning/assetversioning/get_all_asset_versions_4GR_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the original version |
|
|
Include disabled records |
|
|
N/A |
GET Get available SubTypes under a parent document belonging to a specific DocType
/webapi/objectmanagement/metadata/doctype/availablesubtypes_4e_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of parent document
If provided, will apply the restriction of the parent document (some documents only allow specific children with specific subtypes)
|
|
|
Document Type, OrangeLogic.Contracts.Documents.DocType.DocType
|
|
|
N/A |
GET Get available object subtypes for a given table
/webapi/objectmanagement/metadata/objecttypes/getavailablesubtypes_4DB_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get field nodes details
/webapi/objectmanagement/metadata/fields/getfieldnodes_4DR_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Table name (e.g. DO_DOCUMENTS) |
|
|
DbBO name (e.g. Image_DbBO, Staff_DbBO) |
|
|
Field Type to get |
|
|
N/A |
GET Get related values field info
/webapi/objectmanagement/metadata/userfield/getrelatedvaluesfieldinfo_41G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The field name to get |
|
|
The name of the table |
|
|
N/A |
GET Get template by Code and Language
/webapi/objectmanagement/metadata/texttemplate/get_by_code_lang_4BJ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template code |
|
|
Template language |
|
|
To throw error if not found, otherwise return a null result |
|
|
N/A |
GET Get template by ID
/webapi/objectmanagement/metadata/texttemplate/get_by_id_4BI_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template system ID |
|
|
To throw error if not found, otherwise return a null result |
|
|
N/A |
GET Get versioning stores
/webapi/objectmanagement/metadata/versioning/extendedmetadataversioning/getextendedmetadata_4FV_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
TV Record IDs to get extended metadata |
|
|
DK Record IDs to get extended metadata |
|
|
DL Record IDs to get extended metadata |
|
|
CZ Record IDs to get extended metadata |
|
|
N/A |
POST Remove template from a subtype
/webapi/objectmanagement/metadata/texttemplate/removefromsubtype_id_4BO_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Template ID |
|
|
Object subtype
|
POST Remove template from a subtype
/webapi/objectmanagement/metadata/texttemplate/removefromsubtype_code_lang_4BP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Template Code |
|
|
Template Language |
|
|
Object subtype
|
GET Retrieve the authority list for a list of fields or a list of namespaces or a table
/webapi/objectmanagement/metadata/keywords/getauthoritylistbasedfields_23Z_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of the table The default value is "DO_DOCUMENTS" |
|
|
The list of namespaces If fields are filled, this property is ignored |
|
|
List of fields, possible format: 1. Namespaces.FieldName 2. SystemID 3. Arbitrary-string-SystemID |
|
|
N/A |
POST Update existing template
/webapi/objectmanagement/metadata/texttemplate/update_by_id_4BE_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Template system ID |
POST Update existing template
/webapi/objectmanagement/metadata/texttemplate/update_by_code_lang_4BF_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Template Code
|
|
|
Language used in the template |
POST Validate Field
/webapi/objectmanagement/metadata/fields/validatefieldnode_4DQ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The table name, default is DO_DOCUMENTS |
DELETE delete field node
/webapi/objectmanagement/metadata/fields/4DD_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Table name of the subtype |
DELETE delete subtype node
/webapi/objectmanagement/metadata/subtypes/4DJ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Table name of the subtype |
MigrationToUniversalView
GET Post Upgrade Procedure to transfer the old Sort Orders to the new Sort Order System.
/api/MigrationToUniversalView/v1.0/FlushDocumentSortOrdersToParameterTable
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Monitoring (8)
GET API to get check environment from cache. This cache is used by monitoring api to avoid checking environment on each call. Note : If cache does not exist yet, check env will be executed, and cache refreshed. A parameter is available to force refresh. Example call http://sentinel.com/API/Monitoring/v1.0/CheckEnvironmentFromCache
/api/Monitoring/v1.0/CheckEnvironmentFromCache
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Should test continue on error ? |
|
|
Should we check version ? |
|
|
Should we check storage devices ? |
|
|
At what step should we start check env ? |
|
|
Should we run extended tests ? |
|
|
True if cache should be refreshed |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API to run checks to monitor the health of Cortex. Example call http://sentinel.com/API/Monitoring/v1.0/RunChecks
/api/Monitoring/v1.0/RunChecks
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Scope of the check. |
|
|
Polling frequency of the checks to run. |
|
|
Whether or not to only show responses of the failed monitoring APIs. |
|
|
Monitoring API SystemNames to skip, separated by a '|' character. |
|
|
Should this api send metrics into OTLP ? |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Auto create a Meta API monitoring configuration. Example call http://sentinel.com/API/Monitoring/v1.0/AutoCreateConfig?ClientName=Hulu&LocationShortName=HL1&IsProdSite=1
/api/Monitoring/v1.0/AutoCreateConfig
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the client |
|
|
LocationShortName of the site |
|
|
Whether or not this site is a production site |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Check every registered domains
/webapi/upload/monitoring/checkdomains/checkeverydomains_23P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Optionnal : Timeout in ms |
|
|
Should the website network table values be included in the check.
|
|
|
N/A |
PUT Disable monitoring for a list of servers.
/webapi/framework/monitoring/perftest/admin/disablemonitoring_231_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Names of servers to disable monitoring for. Ex. "AAE-USE1-P-APP", "DEV-APE1-D-CMB" |
|
|
Number of minutes to disable monitoring.
|
GET Make a http ping request API/QualityControl/v2.0/Ping to the website itself. This is to ensure the website can access itself over http.
/webapi/framework/monitoring/httpcheck/canselfaccessoverhttp_4c1_v1
Case study defect (also see related defects): https://link.orangelogic.com/Tasks/241KDJ
In the defect, the website failed to make http request to itself. It's suspected to be Docker container issue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Runs a SQL query stored in Cortex parameters and assert that it returns success. Example call https://clientsite.com/API/Monitoring/v1.0/RunCheckFromQuery?Query=DatabaseConsistencyCheck
/api/Monitoring/v1.0/RunCheckFromQuery
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the query to run |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Validate the status of the search index. Example call http://mysite.com/API/Monitoring/v1.0/ValidateSearchIndexStatus
/api/Monitoring/v1.0/ValidateSearchIndexStatus
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
MultiObjectsTools (17)
POST Add a facet to the filter side panel
/webapi/objectmanagement/multiobjectstools/filtersidepanel/addfilterfacet_462_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Search criteria container VForm parameter name E.g: SearchCriteriaContainer_Facets_VForm |
|
|
Facet's search field name Corefield: Prefix + field system name. E.g: CoreField.DocDate
|
|
|
Facet label E.g: My filter panel |
|
|
Position of the facet in the list |
POST Batch edit fields in a list of documents.
/webapi/objectmanagement/multiobjectstools/batchedit/batcheditfields_4FQ_v1
The input meaning:
-
documents: Enter the assets’ Unique Identifier or Media Encrypted Identifier.
-
fieldAssignments:
-
field: Enter the System Name of the metadata field to be edited, such as CoreField.Title or CoreField.OriginalFileName.
-
value: Enter the field’s new value.
-
batchSettings: Information about how to apply a value to a field
-
batchOption: These options correspond to the Batch Edit methods.
-
Options for single- and multi-value fields
-
None: (This is the default value.) Replace the whole value or list of values with the new value.
-
Append: Append the new value to the existing value or list of values.
-
Prepend: Prepend the new value to the existing value or list of values.
-
FindAndReplace: Find a value in the existing value or list of values of the field and replace it with the new value. If you use this option, enter the value to find in the valueToFindAndReplace string.
-
Options for multi-value fields only
-
RemoveFromValues: Remove the value (Tag) from the current list of Tags in the authority list.
-
AugmentAuthorityListsOnTheFly: Create a new value and add it to the field’s authority list (if needed).
-
ignoreNotEditableDocuments: When this parameter is set to true, if there are assets that the user does not have permission to edit, those assets will be ignored.
-
ignoreInvalidDocuments: When this parameter is set to true, if there are assets that are invalid, those assets will be ignored.
See https://link.orangelogic.com/CMS4/Permalinks/2P7YOHURJIA7 for more details
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UseSession |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Document to edit. |
|
|
If true and there are documents that the current user cannot edit, we will ignore those documents and edit the rest. |
|
|
If true and there are documents that are invalid, we will ignore those documents and edit the rest. |
POST Batch edit/create documents/contacts via DataTable API
/webapi/objectmanagement/multiobjectstools/datatable/batchupsert_4FY_v1
Example payload:
{
"dataOptions": {
"table": "Documents", /*The type of records that we want to alter. i.e Documents or Contracts. This is a required field*/
"subtypeForNewRecords": "Documents.Image.Default", /*The subtype of the new records. This is only required when the API request is creating new records*/
"fieldToMatch": "CoreField.Identifier", /*The field that we want to use to find the records that we want to alter. This is a required field*/
"ignoreExistingRecords": false, /*This is an optional field, false by default. If true, the API will not update the existing records. Instead, it will return IGNORED_EXISTING_RECORD code*/
"ignoreMissingRecords": false, /*This is an optional field, false by default. If true, the API will not create new records. Instead, it will return IGNORED_MISSING_RECORD code*/
"multiValueSeparator": "|", /*This is an optional field, default is "|". The separator for multi-value fields if client wants to pass multiple-value fields value as a string, i.e "red|blue|yellow"*/
"augmentAuthorityListsOnTheFly": true, /*This is an optional field, default is false. If true, the API will create new keywords if the provided keywords do not exist in the authority list*/
"maxRecordsAffected": 1 /*This is an optional field, default is 1. It's a safe mechanism to make sure clients don't unintentional alter too many records that match a single provided selection (for example if you use CoreField.Id_Client as fieldToMatch, there are multiple records that can be match if they share the same CoreField.Id_Client)*/
},
"executionOptions": {
"executeSynchronously": true, /*This is an optional field, default is true. If true, the API will execute synchronously. If false, the API will execute asynchronously using the agent and return a job ID, which can be then used to query the request result*/
"successWebHookEndpoint": "https://webhook.site/7662a0e9-a2d3-4eb6-b046-64faba9b6b46", /*Webhook to receive notification in case of a success upsert*/
"failureWebHookEndpoint": "https://webhook.site/7662a0e9-a2d3-4eb6-b046-64faba9b6b46", /*Webhook to receive notification in case of a failure upsert*/
"webHookCustomHttpHeaders": {
"jobID": "demo", /*Custom HTTP headers to be sent with the webhook*/
}
},
"records": [
{
"CoreField.Identifier": "", /*If the fieldToMatch is empty or missing, this means we are creating a new record*/
"CoreField.Title": "new image", /*Title of the new record*/
"CoreField.Keywords": ["key1", "key2"], /*Pass multi-value fields as an array*/
},
{
"CoreField.Identifier": "WA32W6", /*If the fieldToMatch is not empty, this means we are updating an existing record that match CoreField.Identifier = WA32W6*/
"CoreField.Title": "updated Name for old doc",
"CoreField.Keywords": "key1|key2|key3", /*Pass multi-value fields as a string with separator character*/
},
],
}
Example response:
{
"transactionID": "Q0LVT000000030014",
"results": [
{
"recordID": "2Z0ZIF12FAIW",
"matchedFieldValue": "",
"code": "SUCCESS",
"error": null
},
{
"recordID": "2D0Z3F1SFZIA", /*The recordID of the affected record*/
"matchedFieldValue": "WA32W6", /*The value of the fieldToMatch that was used to find the record*/
"code": "SUCCESS",
"error": null
}
],
"executeInBackground": false, /*Indicator if the request was executed synchronously or asynchronously*/
"jobRecordID": null /*If the request was executed asynchronously, this field will contain the job ID*/
}
See https://link.orangelogic.com/CMS4/Permalinks/2P7YOHUNWMO3 for more details
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Batch edit/create documents/contacts via DataTable API that take a CSV file as input The input is multi part form data with the following fields: - file: The CSV file to be processed - dataOptions: The data options for the batch upsert operation - executionOptions: The execution options for the batch upsert operation
/webapi/objectmanagement/multiobjectstools/datatable/batchupsert_csv_4G3_v1
-
Example of dataOptions:
"dataOptions": {
"table": "Documents", /*The type of records that we want to alter. i.e Documents or Contracts. This is a required field*/
"subtypeForNewRecords": "Documents.Image.Default", /*The subtype of the new records. This is only required when the API request is creating new records*/
"fieldToMatch": "CoreField.Identifier", /*The field that we want to use to find the records that we want to alter. This is a required field*/
"ignoreExistingRecords": false, /*This is an optional field, false by default. If true, the API will not update the existing records. Instead, it will return IGNORED_EXISTING_RECORD code*/
"ignoreMissingRecords": false, /*This is an optional field, false by default. If true, the API will not create new records. Instead, it will return IGNORED_MISSING_RECORD code*/
"multiValueSeparator": "|", /*This is an optional field, default is "|". The separator for multi-value fields if client wants to pass multiple-value fields value as a string, i.e "red|blue|yellow"*/
"augmentAuthorityListsOnTheFly": true, /*This is an optional field, default is false. If true, the API will create new keywords if the provided keywords do not exist in the authority list*/
"maxRecordsAffected": 1 /*This is an optional field, default is 1. It's a safe mechanism to make sure clients don't unintentional alter too many records that match a single provided selection (for example if you use CoreField.Id_Client as fieldToMatch, there are multiple records that can be match if they share the same CoreField.Id_Client)*/
},
-
Example of executionOptions:
"executionOptions": {
"executeSynchronously": true, /*This is an optional field, default is true. If true, the API will execute synchronously. If false, the API will execute asynchronously using the agent and return a job ID, which can be then used to query the request result*/
"successWebHookEndpoint": "https://webhook.site/7662a0e9-a2d3-4eb6-b046-64faba9b6b46", /*Webhook to receive notification in case of a success upsert*/
"failureWebHookEndpoint": "https://webhook.site/7662a0e9-a2d3-4eb6-b046-64faba9b6b46", /*Webhook to receive notification in case of a failure upsert*/
"webHookCustomHttpHeaders": {
"jobID": "demo", /*Custom HTTP headers to be sent with the webhook*/
}
},
-
Example csv file content:
Corefield.Identifier, Corefield.Title, CoreField.Keywords
Q0LXKFZKU, Updated title, "red|blue|yellow"
, New record, "red|blue"
Example response:
{
"transactionID": "Q0LVT000000030014",
"results": [
{
"recordID": "2Z0ZIF12FAIW",
"matchedFieldValue": "",
"code": "SUCCESS",
"error": null
},
{
"recordID": "2D0Z3F1SFZIA", /*The recordID of the affected record*/
"matchedFieldValue": "WA32W6", /*The value of the fieldToMatch that was used to find the record*/
"code": "SUCCESS",
"error": null
}
],
"executeInBackground": false, /*Indicator if the request was executed synchronously or asynchronously*/
"jobRecordID": null /*If the request was executed asynchronously, this field will contain the job ID*/
}
See https://link.orangelogic.com/CMS4/Permalinks/2P7YOHUNWMO3 for more details
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
CSV file |
|
|
Data options for batch upsert operation |
|
|
Execution options for batch upsert operation |
POST Create a new filter side panel
/webapi/objectmanagement/multiobjectstools/filtersidepanel/createfiltersidepanel_45Y_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Name of the new side panel |
|
|
The workspace ID that the new side panel is created in |
|
|
Filter location |
DELETE Delete the given facet
/webapi/objectmanagement/multiobjectstools/filtersidepanel/removefilterfacet_464_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID of the side panel that contains the facet |
|
|
ID of the facet node in parameter system |
GET Get all fields that can be used in the filter facet
/webapi/objectmanagement/multiobjectstools/individualfacetsetting/getallfieldsforfacet_466_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the facet list of the given filter side panel
/webapi/objectmanagement/multiobjectstools/filtersidepanel/getfilterfacet_461_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the side panel to retrieve the facets |
|
|
N/A |
DELETE Remove a new filter side panel from the given workspace
/webapi/objectmanagement/multiobjectstools/filtersidepanel/removefiltersidepanel_460_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The workspace ID that the side panel should be removed from |
|
|
Side panel ID to remove |
|
|
Filter location |
PATCH Rename documents by adding auto increasing sequence number.
/webapi/objectmanagement/multiobjectstools/batchrename/addsequence_41Y_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Document IDs to rename. Can be (encrypted / non-encrypted) record IDs or identifier.
|
|
|
Name of the document field to the the rename, e.g. Title or OriginalFileName. |
|
|
If the new name should contain original name. |
|
|
True if the sequence number should be prefix to the original field name value.
|
|
|
True if the extra text should be prefix to the sequence number.
|
|
|
Starting number of the auto increasing sequence. |
|
|
Number of digits of the increasing sequence. |
|
|
Extra text to add to the sequence numbers. |
PATCH Rename documents by append a new text to the original name.
/webapi/objectmanagement/multiobjectstools/batchrename/addsuffix_41X_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Document IDs to rename. Can be (encrypted / non-encrypted) record IDs or identifier.
|
|
|
New text to append to the current field name. |
|
|
Name of the document field to the the rename, e.g. Title or OriginalFileName. |
PATCH Rename documents by find and replace text.
/webapi/objectmanagement/multiobjectstools/batchrename/findandreplace_41V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Document IDs to rename. Can be (encrypted / non-encrypted) record IDs or identifier.
|
|
|
Text that needed to be replaced. |
|
|
New text to replace the current name. |
|
|
Name of the document field to the the rename, e.g. Title or OriginalFileName. |
PATCH Rename documents by prepend a new text to the original name.
/webapi/objectmanagement/multiobjectstools/batchrename/addprefix_41W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Document IDs to rename. Can be (encrypted / non-encrypted) record IDs or identifier.
|
|
|
New text to prepend to the current field name. |
|
|
Name of the document field to the the rename, e.g. Title or OriginalFileName. |
GET Save freeze index of EditableTable
/webapi/objectmanagement/multiobjectstools/datagrid/savefreezeindex_419_v1-beta
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Workspace ID |
|
|
Template ID |
|
|
Index of the column to freeze |
|
|
N/A |
PUT Update a new filter side panel metadata
/webapi/objectmanagement/multiobjectstools/filtersidepanel/updatefiltersidepanel_45Z_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Side panel ID to update |
|
|
New name of the side panel |
PUT Update the given facet
/webapi/objectmanagement/multiobjectstools/filtersidepanel/updatefilterfacet_463_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
ID of the side panel that contains the facet |
|
|
Path of the facet node in parameter system |
|
|
Display name of the facet
|
|
|
Indicate whether the facet should be visible
|
|
|
Position value (in integer) of the facet
|
GET When a batchupsert request is execute in async mode (executionOptions.executeSynchronously = false), the request will be executed in the background by the agent and a jobID will be returned in the response. To query the status as well as the result of the request, use this endpoint with the returned jobID.
/webapi/objectmanagement/multiobjectstools/datatable/query_batchupsert_4G2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the async job |
|
|
N/A |
Notifications (2)
POST Review the notifications which should be fired within an time range
/webapi/workflows/notifications/42i_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Name or Id of the notification rule to search |
|
|
The start date of the time range to search |
|
|
The end date of the time range to search |
|
|
The number of hours to search. Can be positive or negative
|
POST Simulate the notifications which should be fired within an time range
/webapi/workflows/notifications/42j_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Name or Id of the notification rule to search |
|
|
The start date of the time range to search |
|
|
The end date of the time range to search |
|
|
The number of hours to search. Can be positive or negative
|
OCR_BO
GET API to request the OCR execution
/api/OCR_BO/1.0/RequestOcrExecutionFromAsset
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID |
|
|
Parameters |
|
|
Optional indicate status when retry multiple times. This is true by default. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
OLDeleteDocuments
GET Delete document and files if this is media document (original file is moved in Deleted folder). If Provided id is container then this container is deleted
/api/OLDeleteDocuments/v1.0/DeleteDocumentWithFileFormats
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record id of the document |
|
|
MD5 id of the document if it is file |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ObjectManagement (3)
GET API to allow moving/copying an object to a destination and vice versa.
/webapi/objectmanagement/move_object_436_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the object being moved |
|
|
In case the destination ID is not provided, this XML config will be used to retrieve the destination |
|
|
Record ID of the specific container to be used as the destination |
|
|
Record ID of the specific relation to be created between the children and the destination |
|
|
In case the destination rule is used, this would determine whether only the first matched would be used or all matches (in case of copying only) |
|
|
Determine if the destination would be the parent in the relation or the child |
|
|
Determine if the move/copy and properties inheritance should be deduced from teh relation configurations |
|
|
Indicate that this is a copy or a move in case of not using the configurations from the relation |
|
|
Indicates if the properties of the child should be get from the parent in the relation in case of not using the configurations from the relation |
|
|
Determine if we should allow bypass the permission when create the relation |
|
|
N/A |
GET API to allow moving/copying list objects to a destination and vice versa.
/webapi/objectmanagement/moveobjects_4AW_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of RecordIDs of the objects being moved.
|
|
|
In case the destination ID is not provided, this XML config will be used to retrieve the destination |
|
|
Record ID of the specific container to be used as the destination |
|
|
Record ID of the specific relation to be created between the children and the destination |
|
|
In case the destination rule is used, this would determine whether only the first matched would be used or all matches (in case of copying only) |
|
|
Determine if the destination would be the parent in the relation or the child |
|
|
Determine if the move/copy and properties inheritance should be deduced from teh relation configurations |
|
|
Indicate that this is a copy or a move in case of not using the configurations from the relation |
|
|
Indicates if the properties of the child should be get from the parent in the relation in case of not using the configurations from the relation |
|
|
Determine if we should allow bypass the permission when create the relation |
|
|
N/A |
GET Retrieve the list of available sort orders
/webapi/objectmanagement/sortorders_49V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
OneClickRestore
GET API to create an entry of OneClickRestore in HP_HOSTSENTINELPROCEDURE table
/api/OneClickRestore/v1.0/OneClickRestore.Procedure:Create
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the backup to restore |
|
|
Version of the backup to restore |
|
|
Database name of the backup to restore |
|
|
Date at which backup was created |
|
|
Type of the backup (Full or Differential) |
|
|
Size of mdf file in MB |
|
|
Size of ldf file in MB |
|
|
Size of zip file in MB |
|
|
Short location name of the database on which the backup was made be performed |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
OpenSearch (2)
GET Performs a search and returns results in opensearch RSS 2.0 format
/api/OpenSearch/1.1/Search
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Query String |
|
|
Results number |
|
|
Start index |
|
|
Start page |
|
|
Sort order |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns description of OpenSearch provider
/api/OpenSearch/1.1/GetDescription
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Order (3)
GET Add an item to the user's cart
/api/Order/v1.0/Cart.AddItem
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Contact to add item to. It can be a contact encrypted id or an expression ([DataTable/v2.1/Contact.Client:Read?Contact.CoreField.Email1=client@mycompany.com]) |
|
|
System identifier of the asset to add to the cart |
|
|
Calculator sequence |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET List user's cart items
/api/Order/v1.0/Cart.List
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Contact to list the cart items for. It can be a contact encrypted id or an expression ([DataTable/v2.1/Contact.Client:Read?Contact.CoreField.Email1=client@mycompany.com]) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Request cart items
/api/Order/v1.0/RequestItems
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of items (Identifier, OrderIdentifier or RecordID), separated by pipe (|) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
OrderProject (3)
GET Create Approver Contact Group for order
/api/OrderProject/v1.0/CreateApproverContactGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Duplicate Order project and linked invoice
/api/OrderProject/v1.0/DuplicateOrderProject
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target Order |
|
|
Show popup confirmation |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Update requester from Order project to invoice
/api/OrderProject/v1.0/UpdateRequester
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
DataPoints |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
P7_PERFORMANCETESTINNERAPIS_DbBO
GET Synchronize the InnerAPIName field for all non-disabled P7, according to the parameter table in CortexMonitoring_BO
/api/P7_PERFORMANCETESTINNERAPIS_DbBO/v1.0/SyncDatabaseWithParameterTable
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
PackageExtractor
GET Query the content of a package
/API/PackageExtractor/v1.0/Extract
Visibility: [Everyone]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The package encrypted ID |
|
|
N/A |
|
|
N/A |
|
|
Fields relating to the Package itself |
|
|
Fields relating to the Representative Image/Asset for the Package |
|
|
Fields relating to the Images/Assets contained in the Package |
|
|
Filter on children subtype in the Package. Only children of these subtypes are returned.
|
|
|
Filter children based on relations with the Package.
|
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Parameters (2)
POST Compare session parameters and provide verbose output
/webapi/configuration/parameters/comparesessionparams_24t_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
profile (i.e. COR) |
|
|
session id (i.e. 2Y1NB2A0 ) |
POST Trigger check of session activated after X minutes
/webapi/configuration/parameters/delaylinkrequest_491c_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Payment
GET Retrieve the payment info of a specific invoice
/webapi/finance/getpaymentinfo_4FP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
When you click on an invoice in Admin -> Financial -> Transactions, this can be found as 'API ID' at the bottom of the tab 'Invoice header' |
|
|
The Identifier of an invoice, this can be found in column 'Transaction number' in Admin -> Financial -> Transactions |
|
|
The Identifier of an order, this can be found in column 'Order number' in Admin -> Financial -> Transactions |
|
|
Whether to include each payment-allocation / payment-deallocation items |
|
|
N/A |
PaymentProcessor
POST Convert the cost center of all contact from storing record ID to code
/webapi/finance/adyen/notifypayment_4g4_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PersonalFolderManager_BO (2)
GET Get the ID client used to identify user-specific folders
/api/PersonalFolderManager_BO/v1.0/GetUserFolderIdClient
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the user |
|
|
User folder. Supported values: PersonalProfile, PersonalTeam |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get the record ID of a user-specific folder. If that folder doesn't exist it is created.
/api/PersonalFolderManager_BO/v1.0/GetUserFolderRecordID
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of the user |
|
|
User folder. Supported values: PersonalFolder, PersonalProfile |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
PhotoshopEditor (20)
POST Add new text layer
/webapi/tools/photoshop/addtextlayer_4D4_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Top position |
|
|
Left position |
|
|
Text content |
|
|
Font size |
|
|
Font family |
|
|
Text fill color in HEX - Default to black |
|
|
Text alignment |
|
|
Reference layer for positioning newly added layer
|
POST Arrange layer
/webapi/tools/photoshop/arrangelayer_23S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer to arrange |
|
|
Move layer to arrange below this layer
|
|
|
Insert layer as the last child of a layer group
|
|
|
Insert layer as the first child of a layer group
|
POST Edit existing text layer
/webapi/tools/photoshop/edittextlayer_4D5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (11)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
Text content |
|
|
Text portions |
|
|
Font size |
|
|
Font family |
|
|
Text fill color in HEX |
|
|
Text alignment |
|
|
Resize mode after editing |
|
|
Font baseline |
|
|
Auto kerning types
|
POST Export a preview image from a PSD file
/webapi/tools/photoshop/exportpreview_4CT_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
POST Extract image info from a PSD file
/webapi/tools/photoshop/extractinfo_4CU_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
POST Extract layers info from a PSD file
/webapi/tools/photoshop/extractlayers_4CV_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Include preview image for each layer |
|
|
Maximum depth (1-based) to fetch layers, null to fetch all. |
|
|
Layer types |
POST Extract layers info from a PSD file
/webapi/tools/photoshop/exportlayerpreview_4CW_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
POST Get translation providers
/webapi/tools/photoshop/getavailabletranslationproviders_4jh_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Move a layer
/webapi/tools/photoshop/movelayer_4D2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
New top |
|
|
New left |
POST Preview translate text layers without applying to the PSD file.
/webapi/tools/photoshop/previewtranslatetextlayers_4l9_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name, empty to export the whole file. |
|
|
Translation provider ID received from the client side. It's a composite key of provider name and translation profile. Example: OpenAITranslate, OpenAITranslate_trendy |
|
|
Language code to translate from.
|
|
|
Language code to translate to |
|
|
Resize mode after editing |
|
|
Only translate visible layers |
POST Redo change
/webapi/tools/photoshop/redo_4EW_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
POST Remove layer
/webapi/tools/photoshop/removelayer_4EU_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer to remove |
POST Resize PSD file
/webapi/tools/photoshop/resize_4CY_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
New width (based on original image size) |
|
|
New height (based on original image size) |
|
|
Kepp aspect ratio |
POST Resize a layer
/webapi/tools/photoshop/resizelayer_4D1_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
New width |
|
|
New height |
|
|
Resize anchor |
POST Rotate a layer
/webapi/tools/photoshop/rotatelayer_4D3_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
The rotate angle in degrees. Positive values will rotate clockwise |
POST Set opacity of a layer
/webapi/tools/photoshop/setopacity_4D0_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
Layer opacity |
POST Set visibility of a layer
/webapi/tools/photoshop/setvisibility_4CZ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
|
|
Layer unique name |
|
|
Layer visibility |
POST Start editing a PSD file
/webapi/tools/photoshop/startedit_4CS_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
ID of the PSD image |
|
|
Image version |
|
|
Mode to initialize the session |
|
|
Session timeout |
POST Translate text layers and apply to the PSD file.
/webapi/tools/photoshop/translatetextlayers_4ji_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
Include preview image for each layer |
|
|
Use preview output from M:OrangeLogic.Contracts.Tools.Photoshop.IPhotoshopEditorTranslationService.PreviewTranslateTextLayers(OrangeLogic.Contracts.Tools.Photoshop.PreviewTranslateTextLayersRequest)
|
|
|
Edit session ID |
|
|
Layer unique name, empty to export the whole file. |
|
|
Translation provider ID received from the client side. It's a composite key of provider name and translation profile. Example: OpenAITranslate, OpenAITranslate_trendy |
|
|
Language code to translate from.
|
|
|
Language code to translate to |
|
|
Resize mode after editing |
|
|
Only translate visible layers |
POST Undo change
/webapi/tools/photoshop/undo_4EV_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Edit session ID |
PhotoshopTemplate
GET Export a psd template to image
/webapi/tools/photoshop/export_4KS_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template ID (Record ID or identifier)
|
|
|
Name of the layout (artboard) to export.
|
|
|
Output format (default is jpg) |
|
|
Translate texts to target language (optional, leave empty to not translate)
|
|
|
Translation provider (leave empty to use default application provider) |
|
|
Source language (leave empty to auto-detect)
|
|
|
Target output width.
|
|
|
Target output height.
|
|
|
Dimensions unit (default is px) |
|
|
Pixel density (default is 300) |
|
|
Output quality (default is high) |
|
|
Apply the default background to output (Applicable for png) |
|
|
Crop output to match given dimensions (default is center) |
|
|
N/A |
PostUploadWorkflow
GET API to move a document to a subfolder
/api/PostUploadWorkflow/v1.0/MoveToSubFolder
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the target document to move. |
|
|
RecordID of the folder that the target document is in. We will lock the API call executions using this. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
PreTriggers_BO
GET Fires a custom button PreTrigger on a record.
/api/PreTriggers_BO/v1.0/RunCustomButton
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Custom button encrypted identifier |
|
|
Target table |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Printing (5)
POST /webapi/finance/fulfillment/taylor/placeprintingorder_49K_v1
/webapi/finance/fulfillment/taylor/placeprintingorder_49K_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
IH RecordID |
|
|
II RecordID list to filter from all invoice items of the invoice header |
POST For web hook from Taylor
/webapi/finance/fulfillment/taylor/notifyorderchange_49M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Place printing order to FedEx using API v1
/webapi/finance/fulfillment/fedex/placeprintingorder_4CP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Place printing order to FedEx using API v2
/webapi/finance/fulfillment/fedex/placeprintingorder_4CP_v2
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST This API will capture the events sent by FedEx Office and update the status of the orders
/webapi/finance/fulfillment/fedex/notifyorderchange_4CQ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Transaction ID |
|
|
Order number |
|
|
Order status |
|
|
The list of tracking numbers of the shipment items |
Project (8)
POST Adds a Role member
/webapi/project/participant/add_2s_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of the document this member should be attached to |
GET BETA (fake data) - Get list of roles and members attached to specified document id
/webapi/project/participant/2r_v1-beta/{documentId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE BETA (fake data) - Removes a Role member
/webapi/project/participant/2t_v1-beta
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
ID of the document this role/member is attached to |
|
|
ID of the role this member is attached to |
|
|
ID of the member (inside provided role) to remove |
GET Get time track information about a given taskId
/webapi/project/timetrack/23_v1/{taskId}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Id of the task to lookup |
|
|
N/A |
GET Search for a member to be added as a role member (auto completion)
/webapi/project/participant/searchformembers_2u_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document ID
|
|
|
Free text to search on |
|
|
Maximum number of results to bring back
|
|
|
Type of members to search for (Group or Contact or Both)
|
|
|
N/A |
POST Set estimated time on a given taskId
/webapi/project/timetrack/setestimate_4d_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The Task ID |
|
|
The new estimante time in minutes |
POST Start a given taskId
/webapi/project/timetrack/stop_21_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The Task ID |
POST Start time tracking on a given taskId
/webapi/project/timetrack/start_22_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The Task ID |
|
|
The number of minutes to set for OffDesktop |
QualityControl (3)
GET Ping the search engine server
/api/QualityControl/v2.0/PingSearch
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Ping the search engine server
/api/QualityControl/v1.0/PingSearch
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Ping the website
/api/QualityControl/v2.0/Ping
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Parameter in URL |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
QueueAdmin
GET /webapi/messaging/queue/admin/queues_217_v1
/webapi/messaging/queue/admin/queues_217_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
QueueWorkerNodeHistory
GET /webapi/messaging/queueworkernode/monitoring/nodes_21E_v1
/webapi/messaging/queueworkernode/monitoring/nodes_21E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Receiver (3)
POST Export OpenTelemetry logs to the collector
/webapi/monitoring/otlp-http/v1/logs
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Export OpenTelemetry metrics to the collector
/webapi/monitoring/otlp-http/v1/metrics
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Export OpenTelemetry trace to the collector
/webapi/monitoring/otlp-http/v1/traces
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Data options for batch upsert operation |
Relations (13)
POST API to create a new doc link, supports using identifiers for related docs
/webapi/objectmanagement/relations/createdoclink_4B1_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the target DO item, Identifier can be used if RID is unavailable |
|
|
Serialized list of Record IDs of the related DO items to create links with the target DO item |
|
|
The Link Type to create, represented by the Relations unique identifier from Relations_BO.Relations.TableContent |
|
|
Subtype of the LinkType to create |
|
|
Delimiter used to separate multiple values in the RelatedDocumentRIDs string |
|
|
Determine whether to override the default inheritance behavior of the link type |
|
|
Determine whether to use Identifiers for Related docs instead of record IDs |
POST API to create missing mother links (based on the mother field of input documents)
/webapi/objectmanagement/relations/create_missing_mother_links_41JUKB_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The list of document IDs (raw/encrypted RecordIDs or Identifier) |
|
|
If true, we'll remove existing Mother links (of which the input records are
|
GET API to get a tree node used in Graph View
/webapi/objectmanagement/relations/getgraphviewnode_4CE_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Object ID |
|
|
Number of levels to preload
|
|
|
Related assets fetch rules ID |
|
|
N/A |
POST API to get multiple tree nodes used in Graph View
/webapi/objectmanagement/relations/getmultigraphviewnodes_4G6_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Object IDs |
|
|
Number of levels to preload
|
|
|
Related assets fetch rules ID |
POST API to remove an existing doc link
/webapi/objectmanagement/relations/removedoclink_4B4_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Record ID of the target DO item, Identifier can be used if RID is unavailable |
|
|
Serialized list of Identifiers of the related DO items to remove links with the target DO item |
|
|
The record ID of the link type to remove |
|
|
Delimiter used to separate multiple values in the RelatedDocumentIdentifiers string |
POST Apply automatic stacking rules on a list of assets
/webapi/objectmanagement/relations/objectautostack/applyonassets_46I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
the group identifier or recordID of objects |
|
|
the rule must follow to group assets
|
POST Apply automatic stacking rules on a list of assets in a folder
/webapi/objectmanagement/relations/objectautostack/applyonfolder_46Y_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
the Container identifier or encrypted RecordID |
|
|
the rule must follow to group assets
|
GET Create a relation between 2 object. Also able to remove all old relation of the same relation type
/api/Relations/v1.0/CreateRelation
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The target object record id |
|
|
DataPoints. If call from Trigger |
|
|
The relation type want to create between 2 object |
|
|
Remove all existing relationship with this asset before creating new one. This will ensure that between 2 objects, there is at most 1 relation of the same type, same direction |
|
|
The role of the target object in the relation. (Parent/Child) |
|
|
The record id of the object want to create relation with the target object |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Get all available enabled relation rules in Cortex for objects
/webapi/objectmanagement/relations/getenabledrelations_49S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Remove relation to object with a specific relation type
/api/Relations/v1.0/RemoveRelation
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
The relation type of the relation want to remove |
|
|
The direction of the related object that you want to remove (Parent/Child) |
|
|
Boolean indicates updating the UI after removing a relation |
|
|
The record id of the object want to remove relation with the target object |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Retrieve children of the requested container
/webapi/objectmanagement/relations/getcontent_46W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container object record ID
|
|
|
Container document type.
|
|
|
Container document subtype.
|
|
|
Equivalent to the browser See-Thru |
|
|
Optional list of fields to retrieve with the records.
CoreField.Identifier CoreField.TitleWithFallback Person.Email ... |
|
|
While resolving value for OrangeLogic.Contracts.ObjectManagement.Relations.RelatedAsset.GetContentRequest.Fields, we get some extra fields that are not requested. This option will remove those extra fields from the result when set to true. |
|
|
List of subtype criteria.
Images Containers>>Virtual folders ... |
|
|
Additional filter with Cortex Search API syntax.
Text:Contain this text |
|
|
Start row for the search pagination option, 0 is the first record |
|
|
Row count for the search pagination option |
|
|
Define which field is used for ordering the returned assets |
|
|
N/A |
GET Return all available rule name and identifier in ConsolidationRule_BO
/webapi/objectmanagement/relations/objectautostack/displayallavailablerules_487_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Sync dependencies
/webapi/objectmanagement/relations/objectdependencies/syncdependencies_41M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parent object to populate dependencies on children
|
|
|
Set to true to fetch the current dependency items to response |
|
|
Mode to sync |
|
|
Limit number of dependencies to create (1-based)
|
|
|
N/A |
ReleaseDocs
GET DocuSign callback API for registering signed / declined requests
/api/ReleaseDocs/v1.0/DocuSignCallback
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target folder |
|
|
Release document to update |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
RemoteDeviceProxy
GET Checks if device is available
/api/RemoteDeviceProxy/v1.0/CheckDeviceAvailability
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Serialized DbBO fields |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
RepliConfig
GET An API to create a repliconfig on the website
/api/RepliConfig/v1.0/Init
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The repli config key that can init the replication between two websites |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Replication (17)
POST Add files to be replicated (to DF_DOCUMENTSFORFETCH). This is high level API, used in API replication
/webapi/framework/replication/docrecords/schedulefilestoreplicate_48f_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Replication context ID |
POST Clean up the temp file in outgoing replication folder after finish replication in client
/webapi/framework/replication/files/cleanupfileafterdownloading_48V_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
File path |
|
|
Replication context ID |
POST Export changes on remote server to binary data
/webapi/framework/replication/database/exportdata_488_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Local location short name |
|
|
Remote location short name |
|
|
Is proxy |
|
|
Data direction |
|
|
Replication context ID |
POST Export new data inside this server based on a specific condition of a table.
/webapi/framework/replication/database/exportdatafromconditions_498_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Table name to fetch new records based on the input condition. !! Required. If missing, the method will return a warning message to obey the legacy behavior. |
|
|
Location short name of the local site (the site that send this request). !! Required. If missing, the method will return a warning message to obey the legacy behavior. |
|
|
Data direction |
|
|
Replication context ID |
GET Exports parameters, the date range is limited to 1 week to avoid to be too heavy on the database.
/webapi/framework/replication/database/export-last-parameters_25I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Extract file to an outgoing replication folder
/webapi/framework/replication/files/preparefiletodownload_48U_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Replication context ID |
POST Extract new document records to a zip file, then download it.
/webapi/framework/replication/docrecords/download_48e_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Name of the table having the record to be downloaded, e.g. DO_DOCUMENTS. |
|
|
ID of the record to be downloaded. |
|
|
Short name of the location that owns the record to be downloaded, e.g. VN1. |
|
|
Data direction |
|
|
Replication context ID |
POST Get list of documents that need to replicate from local to remote.
/webapi/framework/replication/docrecords/getdocumentstoreplicate_48b_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Either Local or Remote server's short name |
|
|
Tag document to send |
|
|
Replication context ID |
GET Get list of files that need to replicate from the client to the remote
/webapi/framework/replication/files/getfilestoupload_48T_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
If fill this property, we only return a file list of documents that end with this suffix list.
|
|
|
Get document for fetch or document to send |
|
|
Replication context ID |
|
|
N/A |
POST Get the last edit time of the remote server
/webapi/framework/replication/database/getlasteditedinfo_48A_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Local server's short name |
|
|
Local server's proxy state |
|
|
Represents the types of replication connection methods that can be used for a request. |
|
|
Replication context ID |
POST Import zip file contains changes from client to remote server and update remote database based on the file
/webapi/framework/replication/database/importdata_489_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (20)
|
Option Name |
Description |
|---|---|
|
|
File name |
|
|
Buffer ! TODO: later when integrating, if it's hard to pass buffer to API request, we should refactor to allow upload zipped file instead of buffer content Then in the code, we read the buffer content from the file. ! If integrating works well, we should remove this TODO comment |
|
|
Stream type |
|
|
Client location short name |
|
|
Server location short name |
|
|
Table name used to empty additional record |
|
|
Local is proxy |
|
|
Remote is proxy |
|
|
If true, OrangeLogic.Contracts.Framework.Replication.Remote.ImportDataRequest.ReplicationConnectionType is automatic set to DatabaseTools.ReplicationConnectionType.Client_TO_Client |
|
|
Represents the types of replication connection methods that can be used for a request. |
|
|
Parameter profile level 1 |
|
|
Image formats to fetch |
|
|
Video formats to fetch |
|
|
Audio formats to fetch |
|
|
Direction to fetch "documents for fetch" (DF_DOCUMENTSFORFETCH). |
|
|
Doc type list |
|
|
Data direction |
|
|
Use_RT_REMOTETABLES |
|
|
If true, the condition for given table OrangeLogic.Contracts.Framework.Replication.Remote.ImportDataRequest.TableName will be cleared |
|
|
Replication context ID |
POST Increase failures count after replicating a file inside the DF table of this current server.
/webapi/framework/replication/files/increasefilereplicatefailurescount_496_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the requested file to replicate. |
|
|
Format of the requested file to replicate |
|
|
Location short name of the requested file to replicate |
|
|
Replication context ID |
POST Init the replication context. A replication context is a session to transfer replicating data between client and server. <remark>This API is crucial for Cortex to run, therefore everyone can call this API.</remark>
/webapi/framework/replication/context/init_486_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Encrypted username and password from RC.
|
|
|
CLient name that request to create a new replication context.
|
|
|
Local location short name that request to create a new replication context.
|
|
|
Location short name to replicate with (get from param config of the local agent job) !! Warning: Required when using new version of replication (after DENVER) - for older version, it is updated later using UpdateReplicationContext |
|
|
Client short name of the local site that request to create a new replication context. If empty, we will use ClientShortName from the ReplicationConfig and will update to
|
|
|
Init verbose mode for this replication context |
|
|
Agent job recordID that trigger this replication session |
POST Mark the requested file successfully replicated inside the DF table of this current server.
/webapi/framework/replication/files/markfilereplicatedsuccess_497_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the requested file to replicate. |
|
|
Format of the requested file to replicate |
|
|
Location short name of the requested file to replicate |
|
|
Replication context ID |
POST Trigger integrating the recent replicated file in the remote server. !! This API is needed for replication. Therefore anyone can call this API.
/webapi/framework/replication/files/integratereplicatedfile_48W_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
Absolute path of the recent replicated file in the current site. |
|
|
Serialized string represent an IFileInfo.
|
|
|
List of prerequisite formats that will trigger the smaller format generation. If empty, it will generate format "TRX" and "TR1" for this image. |
|
|
List of formats that need to be generated when the replicated file's format is
|
|
|
List of formats that need to update image caches. If the format of the replicated file (OrangeLogic.Contracts.Framework.Replication.Remote.IntegrateReplicatedFileRequest.SerializedFileInfo) is inside this list,
|
|
|
True when the remote server is a proxy.
|
|
|
Replication context ID |
POST Update the replication status of the replicated doc record.
/webapi/framework/replication/docrecords/updatestatus_48d_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
DF Record to be updated |
|
|
Status of the updating DF record |
|
|
Messsage for the updating DF record, if any |
|
|
Replication context ID |
POST Upload the zip file contains new document records to remote and import it to remote's DB.
/webapi/framework/replication/docrecords/upload_48c_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (17)
|
Option Name |
Description |
|---|---|
|
|
File name |
|
|
Buffer |
|
|
Stream type |
|
|
Local location short name |
|
|
Remote location short name |
|
|
Local is proxy |
|
|
Remote is proxy |
|
|
Represents the types of replication connection methods that can be used for a request. |
|
|
Parameter profile level 1 |
|
|
Image formats to fetch |
|
|
Video formats to fetch |
|
|
Audio formats to fetch |
|
|
Direction to fetch "documents for fetch" (DF_DOCUMENTSFORFETCH). |
|
|
Doc type list |
|
|
Data direction |
|
|
Use_RT_REMOTETABLES |
|
|
Replication context ID |
ReplicationCredentialManager (2)
GET Returns caller IP address
/api/ReplicationCredentialManager/v1.0/GetClientIP
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns encrypted recordID of the sentinel account on the caller
/api/ReplicationCredentialManager/v1.0/GetSentinelRecordID
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ReplicationLastRecords (2)
GET Returns last EditDate value from Parameter for my location and other location
/api/ReplicationLastRecords/v2.0/GetLastParameterLightened
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Location to check |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns last EditDate value from current location and all other locations for specified tables
/api/ReplicationLastRecords/v2.0/GetLatestRecordsInTables
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Table names splitted by comma |
|
|
Location to check |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
RestrictionLink (2)
GET Add restrictions to the target record
/api/RestrictionLink/v1.0/AddRestriction
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the restriction to add |
|
|
Name of the restriction to add |
|
|
Type of the restriction to add |
|
|
Start date of the restriction to add |
|
|
End date of the restriction to add |
|
|
The restriction overrides to add with the restriction |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Remove restriction to the target record
/api/RestrictionLink/v1.0/RemoveRestriction
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the restriction to remove |
|
|
Name of the restriction to remove |
|
|
Type of the restriction to remove |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ReturnAPIComplexResponse
GET Get the calculator questions triggered by the given answer
/api/ReturnAPIComplexResponse/v1.0/GetSingleValue
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Value to return |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
RightManagement (3)
POST Assign media rights to an asset
/webapi/objectmanagement/rightmanagement/assignmediarights_239_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the asset to the assigned rights |
|
|
If flag is set, we override existing rights previosuly set to the asset. Otherwise, append new rights to it |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input file |
POST Assign media rights to assets
/webapi/objectmanagement/rightmanagement/assignbatchmediarights_49D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
If flag is set, we override existing rights previosuly set to the asset. Otherwise, append new rights to it |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input file |
GET Export asset right to csv file
/webapi/objectmanagement/rightmanagement/exportmediarighttocsv_49E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
S5_STORAGEDEVICES_DbBO
GET Checks that all the storage devices are available. It is also possible to limit the availability check to a single device by passing its record ID as parameter
/api/S5_STORAGEDEVICES_DbBO/v1.0/CheckDevicesAvailability
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Optional: if not specified, the API will check availability for all devices. If specified, the API will check availability only for this device. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SCIM (7)
GET Aggregate all user accounts info. Start index will default to 1 and count will default to preset config from parameter if not provided
/webapi/crm/scim/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a new user with email, family name, and given name
/webapi/crm/scim/users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure
|
|
|
username of the contact |
DELETE Delete a single user using Record ID
/webapi/crm/scim/users/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a single group using Record ID
/webapi/crm/scim/groups/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get a single user using record ID
/webapi/crm/scim/users/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get all groups info. Start index will default to 1 and count will default to preset config from parameter if not provided
/webapi/crm/scim/groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PATCH Patch a group, adding or removing member with specific link types, to a group using using Record ID and GroupPatchingOperation
/webapi/crm/scim/groups/{id}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SEO (2)
GET Serve a sitemap given its filename
/api/SEO/v1.0/Sitemap
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the sitemap to stream |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Serve a sitemap index given its filename
/api/SEO/v1.0/SitemapIndex
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Name of the sitemap index to stream |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Search (4)
GET Retrieve a list of all fields available on the site
/API/Search/v3.0/ListFields
Visibility: [Everyone]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Retrieve a list of all query criteria available on the site
/API/Search/v3.0/ListCriteria
Visibility: [Everyone]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Search for documents
/API/Search/v4.0/Search
Visibility: [Everyone]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The query criteria. Note: This value must not be URL encoded.
Limitations:
|
|
|
UseSession |
|
|
The order in which you want to retrieve results |
|
|
Fields of the documents to retrieve |
|
|
The number of results you want to have on each page |
|
|
Manage the page numbers you wish to retrieve in your response |
|
|
N/A |
|
|
Get in the response details on how the Search API conducted your query |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Get a permanent URL for each asset path (e.g. Path_TR1) instead of a short lived URL |
|
|
Whether binned assets are included in the result |
|
|
Allow users with the CanExposeBucketSearchAPI security point to get a detailed view of how each asset / format is stored. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Search for documents
/API/Search/v3.0/Search
Visibility: [Everyone]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The query criteria. Note: This value must not be URL encoded.
Limitations:
|
|
|
The order in which you want to retrieve results |
|
|
Fields of the documents to retrieve |
|
|
The number of results you want to have on each page |
|
|
Manage the page numbers you wish to retrieve in your response |
|
|
N/A |
|
|
Get in the response details on how the Search API conducted your query |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Get a permanent URL for each asset path (e.g. Path_TR1) instead of a short lived URL |
|
|
Whether binned assets are included in the result |
|
|
Allow users with the CanExposeBucketSearchAPI security point to get a detailed view of how each asset / format is stored. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SecurityMigration (6)
GET Create security groups from profiles
/api/SecurityMigration/v1.0/MigrateUserProfileAffectationToGroups
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Create security groups from profiles
/api/SecurityMigration/v1.0/MigrateSecurityProfilesToGroups
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Fill GS_GroupSecurity table from SF_SECUFUNCTIONS table
/api/SecurityMigration/v1.0/MigrateSecurityAssignmentsToGroups
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Move security functions from XML to table
/api/SecurityMigration/v1.0/MigrateSecurityFunctionsFromXMLToTable
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Performs all api calls to migrate security
/api/SecurityMigration/v1.0/Migrate
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Renames system groups
/api/SecurityMigration/v1.0/RenameSystemGroupCodes
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SendEmailViaSigniant_BO
GET Open send-email popup on the target record
/api/SendEmailViaSigniant_BO/v1.0/OpenSendEmailPopup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SendMessages
GET Post a message to Slack channels
/api/SendMessages/v1.0/SendSlack
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Profile mode |
|
|
Target channels |
|
|
Credentials |
|
|
Message template |
|
|
Blocks template |
|
|
Additional datas |
|
|
Send now |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SendViaSigniant_BO
GET Open send-email popup on the target record
/api/SendViaSigniant_BO/v1.0/OpenSendEmailPopup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Sentinel (4)
GET An API to fetch statistics on a folder. Does not recurse inside the folder. All dates in UTC and in format: yyyy-MM-dd HH:mm:ss
/api/Sentinel/v1.0/GetFolderInfo
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The path of the folder |
|
|
Pass true to recurse into the folder, default is false |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET An API to fetch statistics on documents.
/api/Sentinel/v1.0/GetDocumentsMaxAge
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Check age of last document records |
|
|
Check age of last document files |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET An API to trigger an alert. Will call the GetDocumentsMaxAge method. If there is an alert, will throw an exception which will return an error 500
/api/Sentinel/v1.0/GetDocumentsMaxAgeAlert
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum age for document records (in minutes) |
|
|
Maximum age for document files (in minutes) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET An API to trigger an alert. Will call the GetFolderInfo method. If there is an alert, will throw an exception which will return an error 500
/api/Sentinel/v1.0/GetFolderInfoAlert
Visibility: [TRUSTED_IPS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The path of the folder |
|
|
Pass true to recurse into the folder, default is false |
|
|
How many files can be in the folder before an alert is triggered |
|
|
How old can the oldest last modified date be, given by difference in minutes with current time, before an alert is triggered |
|
|
How old can the oldest creation date be, given by difference in minutes with current time, before an alert is triggered |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
ServiceStatus
GET API to Determine if an agent associated with Cortex instance is running. http://site.com/API/ServiceStatus/v1.0/Agent
/api/ServiceStatus/v1.0/Agent
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Sessions (2)
PUT Acknowledge a request to Cortex Tools for the current session.
/webapi/framework/sessions/acknowledgecortextoolsreq_21G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Get the current session's Cortex Tools information. This info pertains to the Electron version of Cortex Tools.
/webapi/framework/sessions/getcortextoolsinfo_21F_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Share (11)
POST Create and send approval share to the specified users
/webapi/objectmanagement/share/approval/createapprovalshare_4AO_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (12)
|
Option Name |
Description |
|---|---|
|
|
The ID of the container to share, can be EncryptedRecordID or Identifier |
|
|
Share target to define everyone or specific users
|
|
|
A comma separated list of emails to share with
|
|
|
A comma separated list of emails to share with as view only |
|
|
Default Approval state set to all items when the share is created
|
|
|
State to set to all items when the share is expired
|
|
|
The approval share will be expired after this date.
If not specified, the link will be expired after 3 months (configurable by admin). |
|
|
Link can only be opened from a set number of devices
|
|
|
If LimitDevices is true, this will be the maximum number of devices that can open the link.
|
|
|
Dont allow user click on metadata link when open asset belong to the share |
|
|
Optional. The name of the email template to use for sending email to the stakeholders.
|
|
|
Optional, Share format to apply to all assets in the share
Possible values:
|
GET Generate a download link for the largest downloadable format
/webapi/objectmanagement/share/getlargestdownloadlink_46X_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object record ID |
|
|
Max width |
|
|
Max height |
|
|
This link is used in HTML Image tag |
|
|
If we want to get asset link instead of permanent link
|
|
|
N/A |
POST Get available approval states for a container
/webapi/objectmanagement/share/approval/getapprovalstatelist_4AQ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The ID of the container to share, can be EncryptedRecordID or Identifier |
POST Get available states can be used when auto submit a share
/webapi/objectmanagement/share/approval/getautosubmitstatelist_4AP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The ID of the container to share, can be EncryptedRecordID or Identifier |
GET Get caption content from the caption label and asset key We will return a file with the content of the caption
/webapi/objectmanagement/share/getcaptioncontent_4FL_V1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset key |
|
|
Lable of the caption on the video |
|
|
N/A |
GET Get captions for asset using asset link's access key
/webapi/objectmanagement/share/getcaptions_4FB_V1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset key |
|
|
N/A |
POST Get links for multiple assets of multiple formats
/webapi/objectmanagement/share/getlinks_45W_v1
You can provide asset RecordId OR Identifier. If you provide both, the RecordId will be used.
Possible values for ImageResizingMethod includes:
-
Fit
-
Stretch
-
NorthwestCrop
-
NorthCrop
-
NortheastCrop
-
WestCrop
-
CenterCrop
-
EastCrop
-
SouthwestCrop
-
SouthCrop
-
SoutheastCrop
-
OpticalCrop
-
AICrop
Possible values for ExportMethod includes:
-
None (Default)
-
CSV
See https://link.orangelogic.com/CMS4/Permalinks/2P7YOH5SV8PC for the syntax of the Transformations parameter
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Include the session at the end of the generated links |
|
|
Method to export the result to a file |
GET Get links for single asset
/webapi/objectmanagement/share/getlink_4HZ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset's Record ID (optional if you provide the asset's Unique Identifier). |
|
|
Asset's Unique Identifier (optional if you provide the RecordID). |
|
|
Code of the asset format that you want to generate a link for (TRX, TR1, etc.). |
|
|
True: The link will point to the current version. False: The link will point to the most recent version of the asset. |
|
|
Determine whether OrangeDAM logs each view or download. Administrators can view this information in the Full Logs of Views and Downloads. |
|
|
Determine whether the link downloads the assets. If the link is not configured to be a download link, it will be an embed link. |
|
|
Add an expiration date in the ISO 8601 format: "YYYY-MM-DDTHH:MM:SS.SSSZ" The [sss] value is optional. It is used to represent the UTC offset. For example, "2024-10-31T13:44:39.735Z" |
|
|
Maximum width of the asset. (If you are generating Transformations, the Transformation crop or resize takes precedence over MaxWidth.) |
|
|
Maximum height of the asset. (If you are generating Transformations, the Transformation crop or resize takes precedence over MaxHeight.) |
|
|
File extension of the asset For example, .jpeg, .png, etc. |
|
|
Resizes the image's aspect ratio based on the Maxwidth and MaxHeight. You can provide asset RecordId OR Identifier. If you provide both, the RecordId will be used. Possible values for ImageResizingMethod includes:
|
|
|
Enter a string for each transformation you want to apply to the asset. Transformations are applied in the order in which they appear in the string and take precedence over the maxWidth and maxHeight. This parameter is available beginning in OrangeDAM Kobe. See https://link.orangelogic.com/CMS4/Permalinks/2P7YOH5SV8PC for the syntax to specify transformations. |
|
|
N/A |
POST Schedule the task to share the document via Signiant
/webapi/objectmanagement/share/createsigniantsendingtask_4C4_V1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
If true, the hierarchy will be expanded to include all assets in the hierarchy |
|
|
Expiration date of the share |
|
|
Email addresses which we want to share to |
|
|
The format that being used for all images.
|
|
|
The format that being used for all audios.
|
|
|
The format that being used for all videos.
|
|
|
The email subject for the share |
|
|
The email body for the share that contain the Signiant link |
POST Update select state in an Edit folder for a set of assets
/webapi/objectmanagement/share/approval/update-assets-states_4L_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Link state to update |
|
|
If true, link state will be added or updated.
|
|
|
List of document RecordID to change selecting state |
|
|
Keyword to map between document and link state.
|
|
|
Contextual recordID, or container RecordID of the document list to be update states |
POST Validate the maximum rejection rate of the input approval container.
/webapi/objectmanagement/share/approval/validate-rejection-rate_4O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SingleObjectTools (5)
POST Create new child document of specific type and subtype for parent document
/webapi/objectmanagement/singleobjecttools/create/4f_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
Record ID of parent document |
|
|
Document type (copied from DO_DOCUMENTS_TBO as referencing outside Contract DLL is not allowed) |
|
|
DocSubType to create |
|
|
Allowed relations to create
|
|
|
Relations with parent to create
|
|
|
Determine the container to put new document into OrangeLogic.Contracts.Documents.CreateLocation
|
|
|
Title of the new document |
|
|
Description of the new document |
POST Duplicate the given document
/webapi/objectmanagement/singleobjecttools/clone/41q_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
Document ID to clone |
|
|
Determine if descendents of the given document need to be cloned |
|
|
New title of the cloned document |
|
|
New mother document ID |
|
|
Related document ID that will be used to set the relation with the newly cloned document
|
|
|
Relation ID of the relation with the related document in OrangeLogic.Contracts.ObjectManagement.SingleObjectTools.CloneDocumentModel.RelatedDocumentID
|
GET Find container for new document
/webapi/objectmanagement/singleobjecttools/create/findcontainer_41H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Record ID of parent document |
|
|
Location of new document OrangeLogic.Contracts.Documents.CreateLocation |
|
|
N/A |
POST Get or create folder from path. The user must have the security function GetOrCreateFolderFromPath to be able to use this API
/webapi/objectmanagement/singleobjecttools/objectpath/getorcreatefolderfrompath_437_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Path to get the folder |
|
|
The id of folder to start generate new path from |
|
|
By default, we will generate unique id_client for folder path.
|
GET Replace the asset of object
/webapi/objectmanagement/singleobjecttools/replacement/replace_437_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID of source object |
|
|
The ID of target object |
|
|
N/A |
Solr (3)
GET This API is obsolete.
/api/Solr/v1.0/TransferNonInflectionWordsToNewSystem
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET This API is obsolete.
/api/Solr/v1.0/CreateMissingProtFiles
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET This API is obsolete.
/api/Solr/v1.0/ClearStopWords
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
SoundDesignWorkflows_BO (2)
GET Specific to the sound design workflow. Alters the status of the song project to make it ready for review. Called from the Fast uploader popup.
/api/SoundDesignWorkflows_BO/v1.0/SubmitFilesForReview
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Project recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Specific to the sound design workflow. Creates a sub-project with a configuraiton coming from FBSD_CreateSubProject_VForm.
/api/SoundDesignWorkflows_BO/v1.0/CreateSubProject
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document recordid |
|
|
FBSD_CreateSubProject_VForm parameter name |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Storage (10)
POST /webapi/mediafile/storage/download/downloadfile_4D8_v1
/webapi/mediafile/storage/download/downloadfile_4D8_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The download ID associate with the transaction |
|
|
The index of the file in the download transaction |
|
|
The start byte we want to use to download a part of a file |
|
|
The end byte to specified in the case we want to download a part of a file |
|
|
The expected length of the file we want to download |
|
|
The previous download request record ID |
|
|
The output stream |
GET /webapi/mediafile/storage/download/getassetcloudurl_4D9_v1
/webapi/mediafile/storage/download/getassetcloudurl_4D9_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The download ID associate with the transaction |
|
|
The index of the file in the donload transaction |
|
|
The expected length of the file we want to download in bytes |
|
|
The previous download request record ID |
|
|
N/A |
GET /webapi/mediafile/storage/download/getfilestodownload_4D7_v1
/webapi/mediafile/storage/download/getfilestodownload_4D7_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Download ID associate with the transaction |
|
|
Previous download request record ID |
|
|
N/A |
POST /webapi/mediafile/storage/download/markcancelled_4F7_v1
/webapi/mediafile/storage/download/markcancelled_4F7_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The download ID associate with the transaction |
|
|
The previous download request record ID |
POST /webapi/mediafile/storage/download/markerror_4F9_v1
/webapi/mediafile/storage/download/markerror_4F9_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The download ID associate with the transaction |
|
|
The previous download request record ID |
POST /webapi/mediafile/storage/download/markfinished_4F8_v1
/webapi/mediafile/storage/download/markfinished_4F8_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The download ID associate with the transaction |
|
|
The previous download request record ID |
POST /webapi/mediafile/storage/download/updatefileprogress_4F6_v1
/webapi/mediafile/storage/download/updatefileprogress_4F6_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
The download ID associate with the transaction |
|
|
The previous download request record ID |
|
|
File index |
|
|
Expected file length |
|
|
Downloaded chunk start byte |
|
|
Downloaded chunk end byte |
GET Create CDN distribution
/webapi/mediafile/storage/getsignedurl_21X_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The domain name of the distribution |
|
|
The private key to sign the URL |
|
|
The key pair id corresponding to the private key given |
|
|
The path of the file to build a URL for |
|
|
The expiration date of the signed URL |
|
|
N/A |
GET Get the presigned link for assets to be sent to other parties If the assets are stored in S3/remoted devices, the presigned link will be the directly remote url
/webapi/mediafile/storage/signedurl/getpresignedlink_4ar_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Encrypted Record ID/Unique Identifier of the asset |
|
|
Format code of the asset in the link (Ex: TRX, TR4,...) |
|
|
Indicates whether the asset should be generated if needed.
|
|
|
Indicates whether we need to check if the asset exists or not
|
|
|
Validity duration of the generated link.
|
|
|
N/A |
POST Get the presigned links for assets in batch to be sent to other parties If the assets are stored in S3/remoted devices, the presigned links will be the directly remote url
/webapi/mediafile/storage/signedurl/getpresignedlinks_in_batch_4G8_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Indicates whether the assets should be generated if needed.
|
|
|
Validity duration of the generated links.
|
|
|
Indicates whether we need to check if the asset exists or not
|
StorageMode_BO
GET Change the storage group of an asset
/api/StorageMode_BO/v1.0/SetStorageGroup
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the document. It can be RecordID, Encrypted RecordID or Identifier |
|
|
ID of the storage group to set for the document. It can be RecordID or Encrypted RecordID |
|
|
True to set the storage group even if the document is disabled |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Story (3)
POST Create new child story for parent document
/webapi/objectmanagement/story/create_22J_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Move story to a new parent
/webapi/objectmanagement/story/move_22M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Rename a story
/webapi/objectmanagement/story/rename_22R_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Suggestion (2)
GET Get the suggestion history of the current context
/webapi/ui/suggestion/tiptap/get_suggestion_history_4F1_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
TipTap suggestion document ID |
|
|
TipTap suggestion field ID |
|
|
This indicates the starting record we want to get. In a way you can see it as the number of newest changes we skip getting. |
|
|
This indicates how many record we want to get. This will be used in conjunction with "Start". |
|
|
N/A |
POST Save the suggestion list for a context
/webapi/ui/suggestion/tiptap/save_suggestion_list_4F2_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
TipTap suggestion document ID |
|
|
TipTap suggestion field ID |
Synchronizer (8)
GET Get the sync pull operations to perform for a provided folder
/webapi/mediafile/synchronizer/getsyncpulloperations_228_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Last synchronization date |
|
|
RecordID for the folder |
|
|
Type of sync mode (for permission validation purposes) |
|
|
Download formats per document type
|
|
|
N/A |
GET Returns recent change list (within a certain time window length) happened inside a container as a JSON array.
/api/Synchronizer/v1.0/GetContainerRecentChanges
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Cortex Identifier of the folder we are trying to sync (e.g. OLXSTO123) |
|
|
Date of last synchronization for the target folder. The date must follow this format yyyy-mm-ddThh:mm:ss and use the server time. If no date is provided, the server will list all the files and subfolders present in the target folder. If filled, only the changes since this date will be listed. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the current supported program version
/api/Synchronizer/v1.0/GetCurrentVersion
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the list of recently modified folders which are descendants of a root folder. For each modified folder, this API returns a path from this folder to the root. Example: For the root: OR8STO17593, the list of its modified descendants: [["OR8STO17593","OR8STO17596","OR8STO17682"],["OR8STO17593","OR8STO17598","OR8STO17680"],["OR8STO17593","OR8STO17596","OR8STO17678"]
/api/Synchronizer/v1.0/GetRecentlyModifiedContainers
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Cortex Identifier of the folder we are trying to sync (e.g. OLXSTO123) |
|
|
Date of last synchronization for the target folder. The date must follow this format yyyy-mm-ddThh:mm:ss and use the server time. If no date is provided, the server will list all the files and subfolders present in the target folder. If filled, only the changes since this date will be listed. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the parameters that will be used by Synchronizer desktop application
/api/Synchronizer/v1.0/GetApplicationParameters
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the recommended upload order for a list of files/paths provided as a JSON array.
/api/Synchronizer/v1.1/GetFolderSyncOperations
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Date of last synchronization for the target folder. The date must follow this format yyyy-mm-ddThh:mm:ss and use the server time. If no date is provided, the server will list all the files and subfolders present in the target folder. If filled, only the changes since this date will be listed. |
|
|
Cortex Identifier of the folder we are trying to sync (e.g. OLXSTO123) |
|
|
Files that were changed on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]) |
|
|
Files that were added on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]) |
|
|
Files that were deleted on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]). Does not have any effect for now, we do not delete assets on server. |
|
|
Subfolders that were renamed on client side since the last sync for this folder (e.g. [{"Name":"New name 1","CortexID":"OLXSTO124"},{"Name":"New name 2","CortexID":"OLXSTO125"},...]) |
|
|
Subfolders that were added on client side since the last sync for this folder (e.g. [{"Name":"New name 1"},{"Name":"New name 2"},...]) |
|
|
Subfolders that were deleted on client side since the last sync for this folder (e.g. [{"CortexID":"OLXSTO124"},{"CortexID":"OLXSTO125"},...]). Does not have any effect for now, we do not delete folders on server. |
|
|
What type of synchronization is used by the client. |
|
|
Download formats per doctypes. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the recommended upload order for a list of files/paths provided as a JSON array.
/api/Synchronizer/v1.0/GetFolderSyncOperations
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Date of last synchronization for the target folder. The date must follow this format yyyy-mm-ddThh:mm:ss and use the server time. If no date is provided, the server will list all the files and subfolders present in the target folder. If filled, only the changes since this date will be listed. |
|
|
Cortex Identifier of the folder we are trying to sync (e.g. OLXSTO123) |
|
|
Files that were changed on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]) |
|
|
Files that were added on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]) |
|
|
Files that were deleted on client side since the last sync for this folder (e.g. [{"Name":"File1.jpg","Size":123456},{"Name":"File2.jpg","Size":234567},...]). Does not have any effect for now, we do not delete assets on server. |
|
|
Subfolders that were renamed on client side since the last sync for this folder (e.g. [{"Name":"New name 1","CortexID":"OLXSTO124"},{"Name":"New name 2","CortexID":"OLXSTO125"},...]) |
|
|
Subfolders that were added on client side since the last sync for this folder (e.g. [{"Name":"New name 1"},{"Name":"New name 2"},...]) |
|
|
Subfolders that were deleted on client side since the last sync for this folder (e.g. [{"CortexID":"OLXSTO124"},{"CortexID":"OLXSTO125"},...]). Does not have any effect for now, we do not delete folders on server. |
|
|
What type of synchronization is used by the client. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns true if the logged in user can use the Synchronizer, false otherwise
/api/Synchronizer/v1.0/GetUseRight
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
TaskActivity (6)
GET API endpoint to get the current activity resume
/api/TaskActivity/v1.0/CurrentActivity
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint to set the away status for the current user.
/api/TaskActivity/v1.0/AwayWorkstation
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Est duration of being away from the workstation (minutes) |
|
|
ID of the task to start while being away |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint to start a given task and show the notification (UI needed)
/api/TaskActivity/v1.0/StartTask
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the task to affect action |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET API endpoint to start/stop a given task
/api/TaskActivity/v1.0/StartStop
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the task to affect action |
|
|
Is is a start task action |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET List the stream of the given user
/api/TaskActivity/v1.0/ListStream
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET List the tasks in an range, limited to a certain number
/api/TaskActivity/v1.0/ListTasks
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Start date to filter - standard web UTC format |
|
|
End date to filter - standard web UTC format |
|
|
Max number of tasks to return |
|
|
Offset tasks |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
TaskManager (8)
POST Get or create a sub-task
/webapi/objectmanagement/taskmanager/getorcreatesubtask_42B_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The ID or identifier of parent task |
|
|
SubType ID to create if absent |
|
|
Subtask title |
|
|
Email of owner |
|
|
Email of assignee |
|
|
Estimation in minute |
|
|
N/A |
GET Need maintain behavior
/webapi/objectmanagement/taskmanager/link/shouldcreateoverridetomaintainbehavior_4W3_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Reconcile time track request
/webapi/objectmanagement/reconciletimetrack_4GY_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of the time track request |
POST Set up time track request feature
/webapi/objectmanagement/setuptimetrackrequestfeature_4H0_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Submit time track request
/webapi/objectmanagement/submittimetrack_4GN_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of the time track request |
POST Submit time track request
/webapi/objectmanagement/approvetimetrack_4GO_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of the time track request |
POST Submit time track request
/webapi/objectmanagement/rejecttimetrack_4GP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID of the time track request |
POST Submit time track request
/webapi/objectmanagement/edittimetrack_4GQ_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
ID of the time track request |
|
|
ID of the task |
|
|
Start date of the time tracking |
|
|
End date of the time tracking |
Tasks
GET An API to list critical requests that need to be managed
/api/Tasks/v1.0/GetOpenedCritical
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filter requests to exclude recently created. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
TempAutotaggingBatch
GET Visibility: [EVERYONE]
/api/TempAutotaggingBatch/v1.0/Process
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Min confidence required to process image |
|
|
Process all images or only images that were not auto-tagged before |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Template (8)
GET Add item to cart
/api/Template/v1.0/AddToCart
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Triggered VFormID |
|
|
Quantity |
|
|
Ignore detail popup |
|
|
Calculator Sequence Information |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Clear all states of customization's fields
/api/Template/v1.0/ClearStates
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Customization RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Download or preview a customization
/api/Template/v1.0/DownloadOrPreviewCustomization
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID (Customization or TemplateRID) |
|
|
Mode to process (Download or Preview or DownloadPDF) |
|
|
Include proof watermark |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Re-create a customization
/api/Template/v1.0/RecreateCustomization
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Review document.
/api/Template/v1.0/Review
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Review slot |
|
|
Limit to template recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Show the template's customization to edit
/api/Template/v1.0/Customize
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID (customization) |
|
|
Limit to template recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Submits a customization for review
/api/Template/v1.0/SubmitCustomization
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Transfer ownership of a customization item.
/api/Template/v1.0/TransferOwnership
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Templates (2)
POST Create a template customization
/webapi/templates/customizetemplate_4C6_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Template ID (Record ID or identifier)
|
|
|
Customization's name. If not filled, a default name be given to the customization |
|
|
Produces and imports the PDF rendering in async mode |
GET List all customizable fields of a template
/webapi/templates/listfields_4C5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Template ID (Record ID or identifier)
|
|
|
N/A |
TimeAllocated (2)
GET Get time allocation for a user
/webapi/invisiblehand/timeallocated/getforauser_429_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of the user to get time allocated |
|
|
Get time allocated after or equal this week. If null, it will skip this filter |
|
|
Get time allocated before or equal this week. If null, it will skip this filter |
|
|
Get time allocated belongs to these categories. If null or empty, it will skip this filter |
|
|
N/A |
POST Save time allocation for users
/webapi/invisiblehand/timeallocated/save_42A_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
TimeBasedAsset (2)
POST Create chapters for a video from a text input
/webapi/mediafile/timebasedasset/createorupdatechapters_4b0_v1
The input is a string of chapters, each chapter is separated by a new line
-
Make sure that the first timestamp you list starts with 00:00
-
Timestamps listed in ascending order.
-
Timestamps must be in the format MM:SS or HH:MM:SS
Example:
00:00 - Introduction
00:30 - Chapter 1
01:00 - Chapter 2
01:30 - Chapter 3
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Video record ID to create chapter, support RecordID and Identifier |
|
|
The input is a string of chapters, each chapter is separated by a new line
Example: 00:00 Introduction
|
GET Get all chapters in formatted text Example: 00:00 - Introduction 00:30 - Chapter 1 01:00 - Chapter 2 01:30 - Chapter 3
/webapi/mediafile/timebasedasset/getfullchapterstext_4b5_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Video record ID to get chapter, support RecordID and Identifier |
|
|
N/A |
Tools
GET return a predefined string defined in parameter QC_QualityControl_BO.Data.LongStringToTestBandWidth The purpose here is to test if the bandwidth is good enough, so we do almost zero processing here.
/webapi/tools/qualitycontrol/sendlongstring_4DG_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Transcribe_BO
GET Transcribe media with external services
/api/Transcribe_BO/1.0/TranscribeMedia
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target RecordID |
|
|
Parameters |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Trigger (2)
GET Fire trigger from third party - GET
/webapi/extensibility/triggers/firetrigger/{endpoint}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Fire trigger from third party - POST
/webapi/extensibility/triggers/firetrigger/{endpoint}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
UT_UPLOADTRANSACTION (4)
GET Creates event on upload completion for the given transaction
/api/UT_UPLOADTRANSACTION/v1.0/CreateEventOnUploadCompletion
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Transaction RID |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Indicates if a filename is considrered as a Mezzanine file for the Preservation master/Mezzanine pairing system.
/api/UT_UPLOADTRANSACTION/v1.0/IsFileaMezzanine
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filename to test. (Can also be a relative or an absolute path). |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Indicates if a filename is considrered as a Preservation Master file for the Preservation master/Mezzanine pairing system.
/api/UT_UPLOADTRANSACTION/v1.0/IsFileaPreservationMaster
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filename to test. (Can also be a relative or an absolute path). |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Returns the recommended upload order for a list of files/paths provided as a JSON array.
/api/UT_UPLOADTRANSACTION/v1.0/GetRecommendedUploadOrder
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Files to upload as a JSON array (e.g. ["C:\File1.jpg", "C:\File2.jpg"] or ["Folder\File1.jpg", "Folder\File2.jpg"]) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
UiComponent
GET Get a single file, part of a component
/webapi/extensibility/uicomponent/file_29_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Component name (unique identifier of the component) |
|
|
Name of the file to get |
|
|
N/A |
UniversalView
GET Saves the side panel width in the user preferences.
/api/UniversalView/v1.0/SaveSidePanelWidth
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
True if this is for the right panel, false if this is for the left panel. |
|
|
Type of panel displayed. |
|
|
Preferred width in pixels. |
|
|
ID of the workspace currently used on the UniversalView screen |
|
|
Object family of currently used on UniversalView screen |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Upload
GET Show the upload report command for a document
/webapi/upload/report/showuploadreport_4DP_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The record ID of the container which we want to show the upload report |
|
|
N/A |
UploadInvite_BO
GET Grants read and upload rights to users on a target record and emails an invitation to upload.
/api/UploadInvite_BO/v1.0/SendUploadInvite
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document recordid |
|
|
Recipient users |
|
|
Recipient groups |
|
|
Recipient roles |
|
|
Email template ID |
|
|
Invite subject |
|
|
Invite message |
|
|
Send directly without review |
|
|
Expiration date |
|
|
Set permissions to descendants |
|
|
Asset attachments : use this parameter to attach asset |
|
|
CC requester of the invite on relating reports |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
UploadMedia (4)
POST Upload a new asset to a folder
/api/UploadMedia/v3.0/UploadNewMedia
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID or Identifier of the folder to upload the asset to |
|
|
The name of the file being uploaded |
|
|
Configure the upload mode. Possible Values:
|
|
|
Ignore check container for the parent folder ID.
|
|
|
Metadata to apply to asset, For example: {"CoreField.Title":"New asset title", "MyNameSpace.MyField":"Custom field value"} |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to upload |
POST Upload a new asset to a folder
/api/UploadMedia/v1.0/UploadNewMedia
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the folder to upload the asset to |
|
|
The name of the file being uploaded |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to upload |
POST Upload a new asset to a folder
/api/UploadMedia/v2.0/UploadNewMedia
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the folder to upload the asset to |
|
|
The name of the file being uploaded |
|
|
If set to true, then the asset file will be ingested in the background. After this api returns, the metadata should be applied to the asset but formats and representatives will be delayed. |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to upload |
POST Upload a new version of an asset
/api/UploadMedia/v1.0/UploadNewVersion
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID or Identifier of the asset to upload as a new version of |
|
|
The name of the file being uploaded |
|
|
Configure the upload mode. If not defined, the default value will be ProcessInLine. Possible Values: ProcessInLine
|
|
|
Metadata to apply to asset, For example: {"CoreField.Title":"New asset title", "MyNameSpace.MyField":"Custom field value"} |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The file to upload |
UploadProcess (2)
GET Re-ingest a document file
/api/UploadProcess/v1.0/ReprocessDocument
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID (Document) |
|
|
Synchronous |
|
|
ForceUpdateRepresentative |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Re-ingests a document metadata
/api/UploadProcess/v1.0/ReprocessDocumentMetadata
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Document record ID (a record ID or an identifier must be provided) |
|
|
Document Identifier (a record ID or an identifier must be provided) |
|
|
Ingest mapping name |
|
|
Ingest mapping record ID, takes precedence over the Ingest mapping name |
|
|
Target record ID, takes precedence over DocRecordID and DocIdentifier) |
|
|
Additional parameters serialized as JSON string |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
VUCClient
GET Get status of given tasks.
/api/VUCClient/v1.0/GetTaskStatus
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
ID of tasks |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
Video_DbBO
GET API to fix video representative
/api/Video_DbBO/v1.0/UpdateRepresentatives
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Identifiers of the assets to regenerate proxies for. Can be set to a CSV list of identifiers (example: 'ID1,ID2,ID3'). |
|
|
Video format to extract from |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
WarehouseManagementSystem
GET API to create or update a product to WMS
/api/WarehouseManagementSystem/v1.0/CreateOrUpdateProduct
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
WebHookSubscription (10)
POST /webapi/extensibility/webhook/subscription/create_22E_v1
/webapi/extensibility/webhook/subscription/create_22E_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE /webapi/extensibility/webhook/subscription/delete_22G_v1
/webapi/extensibility/webhook/subscription/delete_22G_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET /webapi/extensibility/webhook/subscription/getall_22I_v1
/webapi/extensibility/webhook/subscription/getall_22I_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET /webapi/extensibility/webhook/subscription/getbyid_22H_v1
/webapi/extensibility/webhook/subscription/getbyid_22H_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/gettopics_22O_v1
/webapi/extensibility/webhook/subscription/gettopics_22O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/rotatesecret_22P_v1
/webapi/extensibility/webhook/subscription/rotatesecret_22P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/testdelivery_22C_v1
/webapi/extensibility/webhook/subscription/testdelivery_22C_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/testpredicates_22D_v1
/webapi/extensibility/webhook/subscription/testpredicates_22D_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/triggerevent_22N_v1
/webapi/extensibility/webhook/subscription/triggerevent_22N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST /webapi/extensibility/webhook/subscription/update_22F_v1
/webapi/extensibility/webhook/subscription/update_22F_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Workflow (24)
GET Activates a task on the target record
/api/Workflow/v2.0/ActivateTask
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the task |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Add the task to the target record
/api/Workflow/v2.0/AddTask
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the task to add |
|
|
Reset task status if already present |
|
|
Check for task conditions |
|
|
Overwrite the existing task if present |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Add the task to the target record's children
/api/Workflow/v2.0/AddTaskToChildren
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the task to add |
|
|
Reset task status if already present |
|
|
Check for task conditions |
|
|
Overwrite the existing task if present |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Apply validation keyword status updates
/api/Workflow/v2.0/ApplyStatusUpdates
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target recordid |
|
|
Perform asynchronous updates |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Easter egg that displays a popup if a VPage instance is avialable
/api/Workflow/v2.0/ShowPopup
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Emit a new WebHook event from a trigger
/api/Workflow/v2.0/EmitWebHook
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
PreTrigger of the event |
|
|
TargetTable of the event |
|
|
DocType of the event |
|
|
DocSubType of the event |
|
|
Target RecordId of the event |
|
|
Topic name of the webhook, automatically deduced from PreTrigger and DocType if not provided |
|
|
Data of the webhook, default to {"RecordID": "[Encrypted RecordID]"} if not provided |
|
|
Datapoints from triggers |
|
|
Identifier of the target record |
|
|
Emit Webhook asynchronously in background |
|
|
Max number of retries for the async emit |
|
|
Indicator that the request comes from EmitWebHook AP task |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Executes an API call with a specific templates (populated from the target record fields)
/api/Workflow/v2.0/CallAPI
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Users' email to notify of errors |
|
|
API call template. Example /API/Module/v1.0/Action?Parameter=Value&OtherParam=[Document.Title] |
|
|
HTTP method (GET, POST, PUT, DELETE) |
|
|
API request data (for POST, PUT) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Executes an external API call with a specific templates (populated from the target record fields)
/api/Workflow/v2.0/CallExternalAPI
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Script template to eval. Example: Utils.ExecuteHttpRequest('https://orangelogic.com/API/Action?Param=[Document.Identifier]') |
|
|
Users' email to notify of errors |
|
|
Execute the script asynchronously with retries |
|
|
Max retries allowed for the async execution |
|
|
Computed PlaceHolders to be used when execute Script |
|
|
External data from third party service, in JSON format |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Gives a sequential number to a field on the target record.
/api/Workflow/v2.0/GiveSequentialNumber
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Target object DbBO |
|
|
Field name (use the same syntax as the DataTable APIs), Must be a core field. |
|
|
Generate an alphanumeric sequance (e.g. CORXD1V6ES). If false the sequance will be numeric (e.g. COR5151) |
|
|
Sequence prefix |
|
|
Overwrite the value fo the target field if already populated |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Inactivates a task on the target record
/api/Workflow/v2.0/InactivateTask
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the task |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Set the task status on the target record
/api/Workflow/v2.0/SetTaskStatus
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the task to set the status |
|
|
ID of the status to set |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sets the purpose on the target record.
/api/Workflow/v2.0/SetPurpose
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
ID of the purpose to set |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sets the value of a field on related assets of the target record.
/api/Workflow/v2.0/SetRelatedAssetsFieldAction
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object RecordId |
|
|
Field name (the same syntax as the DataTable APIs) |
|
|
Field value(s). For multi values fields separate each value by pipes |
|
|
Assignment options |
|
|
Relation rules ID to follow |
|
|
ObjectTypes to filter |
|
|
Direction (PTC: Parent to child, CTP: Child to parent, Both: Both directions) |
|
|
Max affected records |
|
|
Allow to bypass permission (can use for internal call only) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sets the value of a field on the target record.
/api/Workflow/v2.0/SetFieldAction
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Target object DbBO |
|
|
Field name (ise the same syntax as the DataTable APIs) |
|
|
Field value(s). For multi values fields separate each value by pipes |
|
|
Assignment options |
|
|
Allow to bypass permission (can use for internal call only) |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sets the value of fields on the target record with prefilled values.
/api/Workflow/v2.0/SetFieldsAction
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Target object DbBO |
|
|
Prefilled Values, A string table between API name and Value, Can contains placeholder to prefill value from parent |
|
|
Assignment options |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Sets the workflow status on the target record.
/api/Workflow/v2.0/SetWorkflowStatus
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
List of ID of status to consider to set (separated by comma), the first available one will be used. |
|
|
Should bypass edit right or not |
|
|
Force to add the fallback status if none of new statuses is available in the object |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Show fields that must be filled
/api/Workflow/v2.0/AskForFields
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Set of fields that must be filled |
|
|
Show all fields or only not filled fields |
|
|
Popup title |
|
|
Popup description |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Start a project
/api/Workflow/v2.0/StartProject
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Stop a project
/api/Workflow/v2.0/StopProject
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Suggestions allow use to make automated workflows easier for new users by guiding them
/api/Workflow/v2.0/DisplaySuggestions
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Message |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Turn off statuses list of a project. If the statuses is not already in the list of statuses, do nothing.
/api/Workflow/v2.0/TurnOffProjectStatuses
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target project recordid |
|
|
IDs of the status to turn on |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Turn on statuses list a project. If the statuses is not already in the list of statuses, do nothing.
/api/Workflow/v2.0/TurnOnProjectStatuses
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target project recordid |
|
|
IDs of the status to turn on |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Upload a container to a remote Sftp/Ftp server
/api/Workflow/v2.0/UploadContainerSftp
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Container Recordid |
|
|
Vendor Name |
|
|
Vendor Name |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Upload assets to a remote Sftp/Ftp server
/api/Workflow/v2.0/UploadSftp
Visibility: [REGISTERED_USERS]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Server hostname |
|
|
Server port |
|
|
Server protocol |
|
|
Username |
|
|
Password |
|
|
Target recordid |
|
|
Asset formats |
|
|
Upload path (relative to the root folder) |
|
|
Perform asyc upload |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
WorkflowStatuses_BO (3)
GET Action API designed to handle status changes. Evaluates and execute specific triggers based on the previous status and the new status
/api/WorkflowStatuses_BO/v1.0/HandleStatusChange
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object table |
|
|
Target object recordid |
|
|
Source user recordid |
|
|
DataPoints |
|
|
List of triggers to evaluate and execute when entering and leaving each of the statuses |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Change status of a project related to target document
/api/WorkflowStatuses_BO/v1.0/UpdateRelatedProjectsStatus
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Relation to follow |
|
|
Direction to follow (parent to child or child to parent) |
|
|
Status to set |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
GET Current status
/api/WorkflowStatuses_BO/v1.0/Status
Visibility: [EVERYONE]
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Target object recordid |
|
|
Specify response format |
|
|
Specify output date format (Default: yyyy-MM-ddTHH:mm:ss) |
|
|
Force a session id to be used (e.g. CortexXxxxxxx). If not provided falls back on current cookie. |
|
|
N/A |
WorkflowsBuilder
GET Keep the working session alive
/webapi/workflows/builder/keepalivesession_28c_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Workspaces (8)
POST Add a workspace to favorite for a user
/webapi/objectmanagement/workspaces/addtofavorite_46O_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the workspace to add to favorite |
|
|
RecordID of the user which we want to add the workspace to favorite
|
GET Convert workspace object ID to a workspace reference ID
/webapi/objectmanagement/workspaces/convertworkspaceobjectidtoreferenceid_46S_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of objectIDs to convert |
|
|
N/A |
GET Convert workspace reference ID to workspace object ID
/webapi/objectmanagement/workspaces/convertworkspacereferenceidtoobjectid_46T_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
List of referenceIDs to convert to objectIDs |
|
|
N/A |
GET Generate a highlighted search term for an input name. The input name could be workspace name or workspace path.
/webapi/objectmanagement/workspaces/highlightsearchterm_46Q_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Text to highlight. It could be Workspace name / Workspace path |
|
|
Search term to highlight |
|
|
N/A |
GET Perform searching workspaces by search terms
/webapi/objectmanagement/workspaces/search_46M_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Search term. If empty, it will return all workspaces. |
|
|
If filled, it will search workspaces that created by this userID. |
|
|
False by default.
|
|
|
N/A |
POST Remove a workspace from favorite workspaces of a user
/webapi/objectmanagement/workspaces/removefromfavorite_46P_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
RecordID of the workspace to remove from favorite.
|
GET Return favorite workspaces of a specific user
/webapi/objectmanagement/workspaces/getfavorite_46N_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
RecordID of the user which we want to get favorite workspaces
|
|
|
N/A |
GET Return the information of the root object to store workspaces hierarchy
/webapi/objectmanagement/workspaces/getworkspacerootobject_46R_v1
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |