User Data Management API

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Genesys Multicloud CX Web-based API Reference for version Current of Developer.



Base path: /udm

Version 10 API Requests

GET
/v10/cipher
This request is intended to get already uploaded certificate info.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
Responses
Code Reason
200 200 response 
{
  "ccid": "string",
  "name": "string",
  "size": 0,
  "lastModified": "string"
}
CertificateInfo
ccid (string):
name (string):
size (integer):
lastModified (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/cipher?"
POST
/v10/cipher/{certificatefilename}
This request is intended to upload a certificate.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
certificatefilename path string true
file The certificate content, <input> field name must be 'file' formData file true
Responses
Code Reason
201 201 response 
"string"
400 400 response
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/cipher/{certificatefilename}?"
GET
/v10/data/attributes
This request is intended to get allow filtering on top of interaction attributes.
Parameters
Name Default Description Parameter Type Data Type Required
entities query string
Responses
Code Reason
200 200 response 
{}
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/data/attributes?entities=string"
GET
/v10/data/job-statuses
This request is intended to get a list of job statuses.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
Responses
Code Reason
200 200 response 
{}
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/data/job-statuses?"
GET
/v10/data/sources
This request is intended to get a list of sources.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
Responses
Code Reason
200 200 response 
{}
204 204 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/data/sources?"
GET
/v10/data/sub-types
This request is intended to get a list of entities for specific type and source.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
dataType query string
source query string
Responses
Code Reason
200 200 response 
{}
204 204 response
400 400 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/data/sub-types?dataType=string&source=string"
GET
/v10/data/types
This request is intended to get a list of types for specific source.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
source query string
Responses
Code Reason
200 200 response 
{}
204 204 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/data/types?source=string"
GET
/v10/export/history
This request is intended to get a list of history records.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
descAsc query string
jobId query string
type query string
orderField query string
fileName query string
status query string
from query string
title query string
size query string
source query string
bgUpdate query string
Responses
Code Reason
200 200 response 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
items
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
204 204 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/history?descAsc=string&jobId=string&type=string&orderField=string&fileName=string&status=string&from=string&title=string&size=string&source=string&bgUpdate=string"
DELETE
/v10/export/history
This request is intended to delete a bunch of history records.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
jobIDs query string true
Responses
Code Reason
204 204 response
400 400 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/history?jobIDs=string"
GET
/v10/export/history/{id}
This request is intended to get history record info.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
404 404 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/history/{id}?"
DELETE
/v10/export/history/{id}
This request is intended to delete a history record.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
204 204 response
400 400 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/history/{id}?"
GET
/v10/export/history/{id}/progress
This request is intended to get job progress.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response 
{
  "progress": 0,
  "status": "string"
}
JobProgress
progress (integer):
status (string):
400 400 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/history/{id}/progress?"
GET
/v10/export/jobs
This request is intended to get a list of jobs.
Parameters
Name Default Description Parameter Type Data Type Required
descAsc query string
scheduleType query string
x-api-key header string
type query string
orderField query string
suspend query string
from query string
title query string
size query string
source query string
bgUpdate query string
Responses
Code Reason
200 200 response 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
items
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
204 204 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs?descAsc=string&scheduleType=string&type=string&orderField=string&suspend=string&from=string&title=string&size=string&source=string&bgUpdate=string"
POST
/v10/export/jobs
This request is intended to create a job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
Job body true 
{
  "source": "string",
  "type": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ],
    "exportAttachments": true
  },
  "suspended": true
}
TimeFrame
all (boolean, optional):
dateFrom (string, optional):
dateTo (string, optional):
SchedulerParam
immediately (boolean, optional):
cron (string, optional):
runs (string, optional):
startDate (string, optional):
UcsJobParams
fileSplitSize (string, optional):
type (string, required):
media (array:string, required):
exportAttachments (boolean, optional):
Job
source (string, required): source of job
type (string, required): UCS or DataSync
title (string, required): title of job
timeFrame (TimeFrame, required): export time parameter of job
description (string, optional): A description
schedulerParam (SchedulerParam, required): scheduler parameter of job
jobParams (UcsJobParams, required): parameters of job
suspended (boolean, required): suspended job
Responses
Code Reason
202 202 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
  "source": "string",
  "type": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ],
    "exportAttachments": true
  },
  "suspended": true
}'
"https://api-demo.com/udm/v10/export/jobs?"
DELETE
/v10/export/jobs
This request is intended to delete a bunch of jobs.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
jobIDs query string true
Responses
Code Reason
204 204 response
400 400 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs?jobIDs=string"
POST
/v10/export/jobs/cancel/{id}
This request is intended to cancel an unfinished job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response
400 400 response
404 404 response
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs/cancel/{id}?"
POST
/v10/export/jobs/resume/{id}
This request is intended to resume an unfinished job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
source (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
createdDate (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
404 404 response
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs/resume/{id}?"
POST
/v10/export/jobs/suspend/{id}
This request is intended to suspend an unfinished job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
source (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
createdDate (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
404 404 response
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs/suspend/{id}?"
GET
/v10/export/jobs/{id}
This request is intended to get job info.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
200 200 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
source (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
createdDate (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
404 404 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs/{id}?"
PUT
/v10/export/jobs/{id}
This request is intended to update not started job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Job body true 
{
  "source": "string",
  "type": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ],
    "exportAttachments": true
  },
  "suspended": true
}
TimeFrame
all (boolean, optional):
dateFrom (string, optional):
dateTo (string, optional):
SchedulerParam
immediately (boolean, optional):
cron (string, optional):
runs (string, optional):
startDate (string, optional):
UcsJobParams
fileSplitSize (string, optional):
type (string, required):
media (array:string, required):
exportAttachments (boolean, optional):
Job
source (string, required): source of job
type (string, required): UCS or DataSync
title (string, required): title of job
timeFrame (TimeFrame, required): export time parameter of job
description (string, optional): A description
schedulerParam (SchedulerParam, required): scheduler parameter of job
jobParams (UcsJobParams, required): parameters of job
suspended (boolean, required): suspended job
Responses
Code Reason
200 200 response 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0,
  "exportAttachments": true
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
exportAttachments (boolean):
400 400 response
404 404 response
Usage
curl -X PUT
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
  "source": "string",
  "type": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ],
    "exportAttachments": true
  },
  "suspended": true
}'
"https://api-demo.com/udm/v10/export/jobs/{id}?"
DELETE
/v10/export/jobs/{id}
This request is intended to delete finished job.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
id path string true
Responses
Code Reason
204 204 response
400 400 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/export/jobs/{id}?"
GET
/v10/file-metadatas
This request is intended to get a list of files data.
Parameters
Name Default Description Parameter Type Data Type Required
historyId query string
descAsc query string
jobTitle query string
x-api-key query string
name query string
type query string
source query string
endDate query string
orderField query string
startDate query string
from query string
size query string
bgUpdate query string
Responses
Code Reason
200 200 response 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
items
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/file-metadatas?historyId=string&descAsc=string&jobTitle=string&name=string&type=string&source=string&endDate=string&orderField=string&startDate=string&from=string&size=string&bgUpdate=string"
GET
/v10/files
This request is intended to get a bunch of links to download files.
Parameters
Name Default Description Parameter Type Data Type Required
filename query string
x-api-key header string
Responses
Code Reason
200 200 response 
{
  "path": "string"
}
PreSignedUri
path (string):
400 400 response
404 404 response 
{}
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/files?filename=string"
DELETE
/v10/files
This request is intended to delete a bunch of files.
Parameters
Name Default Description Parameter Type Data Type Required
filename query string true
x-api-key header string
Responses
Code Reason
204 204 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/files?filename=string"
GET
/v10/files/{filename}
This request is intended to download a file.
Parameters
Name Default Description Parameter Type Data Type Required
filename path string true
x-api-key header string
Responses
Code Reason
303 303 response
404 404 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/files/{filename}?"
DELETE
/v10/files/{filename}
This request is intended to delete a file.
Parameters
Name Default Description Parameter Type Data Type Required
filename path string true
x-api-key header string
Responses
Code Reason
204 204 response
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/files/{filename}?"
GET
/v10/resources/labels
This request is intended to get labels and their values.
Responses
Code Reason
200 200 response
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/resources/labels?"
GET
/v10/version
This request is intended to get service info.
Parameters
Name Default Description Parameter Type Data Type Required
x-api-key header string
Responses
Code Reason
200 200 response 
{
  "version": "string",
  "buildNumber": "string",
  "changeset": "string",
  "name": "string"
}
VersionInfo
version (string):
buildNumber (string):
changeset (string):
name (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v10/version?"

Version 4 API Requests

Important
Although the User Data Management API still supports version 4 API calls documented below, they have been deprecated.
GET
Deprecated
/v4/export/history
Get list of jobs info
Parameters
Name Default Description Parameter Type Data Type Required
descAsc Specifies the sort order of orderField. False for ascending order, true for descending query boolean
orderField By which field to order query string
title Filter that title contains query string
fileName Filter that file name contains query string
type Filter that type contains query string
status Filter that file name contains query string
from 0 Index of the first item to return query integer
size 999999999 Maximum number of items to return query integer
Responses
Code Reason
200 Ok 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
204 No Content
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/history?descAsc=true&orderField=string&title=string&fileName=string&type=string&status=string&from=0&size=0"
DELETE
Deprecated
/v4/export/history
Delete the specified jobs list

In case if some jobs cannot be deleted internal server error is returned with a list of jobs that weren't deleted as json array in the body. A job with status in progress cannot be deleted.

Parameters
Name Default Description Parameter Type Data Type Required
jobIDs A comma-separated list of job IDs query string true
Responses
Code Reason
204 No Content
400 Bad Request
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/history?jobIDs=string"
GET
Deprecated
/v4/export/history/{id}
Get specified jobs history
Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
200 Ok 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
filename (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
400 Bad Request
404 ManualJob Not Found
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/history/{id}?"
DELETE
Deprecated
/v4/export/history/{id}
Delete the specified job

A job in progress can not be deleted.

Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
204 No Content
400 Bad Request
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/history/{id}?"
GET
Deprecated
/v4/export/history/{id}/progress
Get currently running job completion progress

Return value is between 0 and 100 percent.

Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job history path string true
Responses
Code Reason
200 Ok 
{
  "progress": 0,
  "status": "string"
}
JobProgress
progress (integer):
status (string):
400 Bad Request
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/history/{id}/progress?"
GET
Deprecated
/v4/export/jobs
Get list of jobs info
Parameters
Name Default Description Parameter Type Data Type Required
descAsc Specifies the sort order of orderField. False for ascending order, true for descending query boolean
orderField By which field to order query string
title Filter that title contains query string
type Filter that type contains query string
scheduleType Filter that file name contains query string
suspend Filter that schedule type contains query boolean
from 0 Index of the first item to return query integer
size 999999999 Maximum number of items to return query integer
Responses
Code Reason
200 Ok 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
204 No Content
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs?descAsc=true&orderField=string&title=string&type=string&scheduleType=string&suspend=true&from=0&size=0"
POST
Deprecated
/v4/export/jobs
Save specified manualJob
Parameters
Name Default Description Parameter Type Data Type Required
body body 
{
  "source": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "fileSplitSize": "string",
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ]
  },
  "suspended": "string"
}
TimeFrame
all (boolean, optional):
dateFrom (string, optional):
dateTo (string, optional):
SchedulerParam
immediately (boolean, optional):
cron (string, optional):
runs (string, optional):
startDate (string, optional):
UcsJobParams
fileSplitSize (string, optional):
type (string, required):
media (array:string, required):
Job
source (string, required): source of job
title (string, required): title of job
timeFrame (TimeFrame, required): export time parameter of job
fileSplitSize (string, optional): size of splitted file
description (string, optional): A description
schedulerParam (SchedulerParam, required): scheduler parameter of job
jobParams (UcsJobParams, required): parameters of job
suspended (string, required): suspended job
Responses
Code Reason
202 Accepted 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
400 Bad Request
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
  "source": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "fileSplitSize": "string",
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ]
  },
  "suspended": "string"
}'
"https://api-demo.com/udm/v4/export/jobs?"
DELETE
Deprecated
/v4/export/jobs
Delete the specified jobs list

In case if some jobs cannot be deleted internal server error is returned with a list of jobs that weren't deleted as json array in the body. A job with status in progress cannot be deleted.

Parameters
Name Default Description Parameter Type Data Type Required
jobIDs A comma-separated list of job IDs query string true
Responses
Code Reason
204 No Content
400 Bad Request
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs?jobIDs=string"
POST
Deprecated
/v4/export/jobs/cancel/{id}
Cancel running
Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
200 Ok
400 Bad Request
404 Not Found
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs/cancel/{id}?"
POST
Deprecated
/v4/export/jobs/resume/{id}
Save specified manualJob
Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
200 Ok 
{
    "status": {
        "code": 0,
        "detail": {},
        "message": "successful"
    }
}
400 Bad Request
404 Job Not Found
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs/resume/{id}?"
POST
Deprecated
/v4/export/jobs/suspend/{id}
Save specified manualJob
Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
200 Ok 
{
    "status": {
        "code": 0,
        "detail": {},
        "message": "successful"
    }
}
400 Bad Request
404 Job Not Found
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs/suspend/{id}?"
GET
Deprecated
/v4/export/jobs/{id}
Get specified job
Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
200 Ok 
{
  "id": "",
  "source": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "fileSplitSize": "string",
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [
]
  },
  "suspended": "string"
}
400 Bad Request
404 ManualJob Not Found
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs/{id}?"
PUT
Deprecated
/v4/export/jobs/{id}
Save specified manualJob
Parameters
Name Default Description Parameter Type Data Type Required
id path string true
body body 
{
  "source": "string",
  "title": "string",
  "type": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "fileSplitSize": "string",
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ]
  },
  "suspended": "string"
}
TimeFrame
all (boolean, optional):
dateFrom (string, optional):
dateTo (string, optional):
SchedulerParam
immediately (boolean, optional):
cron (string, optional):
runs (string, optional):
startDate (string, optional):
UcsJobParams
fileSplitSize (string, optional):
type (string, required):
media (array:string, required):
Job
source (string, required): source of job
title (string, required): title of job
type (string, required): type of job
timeFrame (TimeFrame, required): export time parameter of job
fileSplitSize (string, optional): size of splitted file
description (string, optional): A description
schedulerParam (SchedulerParam, required): scheduler parameter of job
jobParams (UcsJobParams, required): parameters of job
suspended (string, required): suspended job
Responses
Code Reason
200 Ok 
{
  "id": 0,
  "type": "string",
  "source": "string",
  "title": "string",
  "fileSplitSize": "string",
  "fileName": "string",
  "fileSize": 0,
  "status": "string",
  "createdDate": "string",
  "dateFrom": "string",
  "dateTo": "string",
  "description": "string",
  "media": [

  ],
  "progress": 0,
  "parentId": 0
}
JobInfo
id (integer):
type (string):
source (string):
title (string):
fileSplitSize (string):
fileName (string):
fileSize (integer):
status (string):
createdDate (string):
dateFrom (string):
dateTo (string):
description (string):
media (array:string):
progress (integer):
parentId (integer):
400 Bad Request
404 Job Not Found
Usage
curl -X PUT
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
  "source": "string",
  "title": "string",
  "timeFrame": {
    "all": true,
    "dateFrom": "string",
    "dateTo": "string"
  },
  "fileSplitSize": "string",
  "description": "string",
  "schedulerParam": {
    "immediately": true,
    "cron": "string",
    "runs": "string",
    "startDate": "string"
  },
  "jobParams": {
    "fileSplitSize": "string",
    "type": "string",
    "media": [

    ]
  },
  "suspended": "string"
}'
"https://api-demo.com/udm/v4/export/jobs/{id}?"
DELETE
Deprecated
/v4/export/jobs/{id}
Delete the specified job

A job in progress can not be deleted.

Parameters
Name Default Description Parameter Type Data Type Required
id The id of the job path string true
Responses
Code Reason
204 No Content
400 Bad Request
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v4/export/jobs/{id}?"

Version 3 API Requests

Important
Although the User Data Management API still supports version 3 API calls documented below, they have been deprecated.
GET
Deprecated
/v3/cipher
Get certificate information
Responses
Code Reason
200 Ok 
{
  "ccid": "string",
  "name": "string",
  "size": 0,
  "lastModified": "string"
}
CertificateInfo
ccid (string):
name (string):
size (integer):
lastModified (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/cipher?"
POST
Deprecated
/v3/cipher/{certificatefilename}
POST the specified certificate
Parameters
Name Default Description Parameter Type Data Type Required
certificatefilename path string true
file formData file
Responses
Code Reason
201 Created 
"string"
400 Bad Request
Usage
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/cipher/{certificatefilename}?"
GET
Deprecated
/v3/data/job-statuses
Get list of job statuses
Responses
Code Reason
200 Ok 
[
  {
    "label": "string",
    "value": "string"
  }
]
KeyValueItem
label (string):
value (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/data/job-statuses?"
GET
Deprecated
/v3/data/sources
Get list of sources
Responses
Code Reason
200 Ok 
[
  {
    "label": "string",
    "value": "string"
  }
]
KeyValueItem
label (string):
value (string):
204 No Content
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/data/sources?"
GET
Deprecated
/v3/data/sub-types
Get list of data subtypes
Parameters
Name Default Description Parameter Type Data Type Required
source Filter data sub types by source query string
dataType Filter data types by type query string
Responses
Code Reason
200 Ok 
[
  {
    "name": "string",
    "displayName": "string",
    "source": "string",
    "dataType": "string",
    "enabled": true
  }
]
SubType
name (string):
displayName (string):
source (string):
dataType (string):
enabled (boolean):
204 No Content
400 Bad Request
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/data/sub-types?source=string&dataType=string"
GET
Deprecated
/v3/data/types
Get list of types
Parameters
Name Default Description Parameter Type Data Type Required
source Filter data types by source query string
Responses
Code Reason
200 Ok 
[
  {
    "name": "string",
    "source": "string"
  }
]
DataType
name (string):
source (string):
204 No Content
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/data/types?source=string"
GET
Deprecated
/v3/file-metadatas
Get list of files metadata
Parameters
Name Default Description Parameter Type Data Type Required
descAsc Specifies the sort order of orderField. False for ascending order, true for descending query boolean
orderField By which field to order query string
startDate startDate query string
endDate Filter to which upload date query string
name Filter that file name contains query string
jobTitle Filter that job title contains query string
type Filter that file type contains query string
from 0 Index of the first item to return query integer
size 999999999 Maximum number of items to return query integer
Responses
Code Reason
200 Ok 
{
  "count": 0,
  "from": 0,
  "items": [

  ],
  "size": 0
}
PagedResponse
count (integer):
from (integer):
items (array:object):
size (integer):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/file-metadatas?descAsc=true&orderField=string&startDate=string&endDate=string&name=string&jobTitle=string&type=string&from=0&size=0"
GET
Deprecated
/v3/files
Get the list of pre-signed url for specified files list

The maximum number of files is limited to 100. Also if some files cannot be found HTTP 404 is returned with a list of the files that weren’t found as json array in the body

Parameters
Name Default Description Parameter Type Data Type Required
filename A comma-separated list of file names query string
Responses
Code Reason
200 Ok 
{
  "path": "string"
}
PreSignedUri
path (string):
400 Bad Request
404 File Not Found 
[
  {
    "path": "string"
  }
]
PreSignedUri
path (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/files?filename=string"
DELETE
Deprecated
/v3/files
Delete the specified files list

In case if some files cannot be deleted internal server error is returned with a list of files that weren’t deleted as json array in the body.

Parameters
Name Default Description Parameter Type Data Type Required
filename A comma-separated list of file names query string true
Responses
Code Reason
204 No Content
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/files?filename=string"
GET
Deprecated
/v3/files/{filename}
Get the specified file
Parameters
Name Default Description Parameter Type Data Type Required
filename The name of the file path string true
Responses
Code Reason
303 See Other
404 File Not Found
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/files/{filename}?"
DELETE
Deprecated
/v3/files/{filename}
Delete the specified file
Parameters
Name Default Description Parameter Type Data Type Required
filename The name of the file path string true
Responses
Code Reason
204 No Content
Usage
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/files/{filename}?"
GET
Deprecated
/v3/version
Get version information
Responses
Code Reason
200 Ok 
{
  "version": "string",
  "buildNumber": "string",
  "changeset": "string",
  "name": "string"
}
VersionInfo
version (string):
buildNumber (string):
changeset (string):
name (string):
Usage
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/udm/v3/version?"
Retrieved from "https://all.docs.genesys.com/PEC-Developer/Current/WebAPIs/UDM_Data-download (2024-04-27 14:11:06)"
Comments or questions about this documentation? Contact us for support!