{
"opencollection": "1.0.0",
"info": {
"name": "Coveo Activity Activities Sources API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"items": [
{
"info": {
"name": "Sources",
"type": "folder"
},
"items": [
{
"info": {
"name": "Validates a Slack OAuth Token",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/SLACK/validateToken",
"params": [
{
"name": "accessTokenGuid",
"value": "",
"type": "query",
"description": "The OAuth token Guid linked with the token to validate."
},
{
"name": "accessToken",
"value": "",
"type": "query",
"description": "The OAuth token to validate."
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Validates a Slack OAuth Token"
},
{
"info": {
"name": "Retrieves the Default Objects for a Source of Type Specified.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/defaultObjectsToGet",
"params": [
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the Default Objects for a Source of Type Specified."
},
{
"info": {
"name": "Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/entities",
"params": [
{
"name": "accessTokenGuid",
"value": "",
"type": "query",
"description": "The source's access token Guid (if authentified through access token)"
},
{
"name": "entityIds",
"value": "",
"type": "query",
"description": "IDs of the entities to retrieve (comma-separated list)"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The number of entities to retrieve"
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "Starting index of the first entity to retrieve"
},
{
"name": "query",
"value": "",
"type": "query",
"description": "A query used to match specific entities"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The source's username (if authentified through OAuth)."
},
{
"name": "passwordGuid",
"value": "",
"type": "query",
"description": "The source's password Guid (if authentified through Basic Auth)"
},
{
"name": "clientId",
"value": "",
"type": "query",
"description": "The source's client id(if authentified through OAuth)."
},
{
"name": "clientSecretGuid",
"value": "",
"type": "query",
"description": "The source's client secret Guid (if authentified through OAuth)."
},
{
"name": "oauthRefreshTokenGuid",
"value": "",
"type": "query",
"description": "The source's refresh token Guid (if authentified through OAuth)."
},
{
"name": "instanceUrl",
"value": "",
"type": "query",
"description": "The source's instance Url."
},
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the List of Entities Present in a Source, in Alphabetical Order of Display Names."
},
{
"info": {
"name": "Retrieves the Entity Specified with Its Fields.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/entities/:entityId",
"params": [
{
"name": "filter",
"value": "",
"type": "query",
"description": "The record count filter"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The source's username (if authentified through OAuth)."
},
{
"name": "passwordGuid",
"value": "",
"type": "query",
"description": "The source's password Guid (if authentified through Basic Auth)"
},
{
"name": "clientId",
"value": "",
"type": "query",
"description": "The source's client id(if authentified through OAuth)."
},
{
"name": "clientSecretGuid",
"value": "",
"type": "query",
"description": "The source's client secret Guid (if authentified through OAuth)."
},
{
"name": "oauthRefreshTokenGuid",
"value": "",
"type": "query",
"description": "The source's refresh token Guid (if authentified through OAuth)."
},
{
"name": "instanceUrl",
"value": "",
"type": "query",
"description": "The source's instance Url."
},
{
"name": "entityId",
"value": "",
"type": "path",
"description": "The id of the entity"
},
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the Entity Specified with Its Fields."
},
{
"info": {
"name": "Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/entities/:entityId/fields",
"params": [
{
"name": "username",
"value": "",
"type": "query",
"description": "The source's username (if authentified through OAuth)."
},
{
"name": "passwordGuid",
"value": "",
"type": "query",
"description": "The source's password Guid (if authentified through Basic Auth)"
},
{
"name": "clientId",
"value": "",
"type": "query",
"description": "The source's client id(if authentified through OAuth)."
},
{
"name": "clientSecretGuid",
"value": "",
"type": "query",
"description": "The source's client secret Guid (if authentified through OAuth)."
},
{
"name": "oauthRefreshTokenGuid",
"value": "",
"type": "query",
"description": "The source's refresh token Guid (if authentified through OAuth)."
},
{
"name": "instanceUrl",
"value": "",
"type": "query",
"description": "The source's instance Url."
},
{
"name": "entityId",
"value": "",
"type": "path",
"description": "The name of the entity"
},
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Retrieves the Specified Entity, with Its Fields in Alphabetical Order of Display Names."
},
{
"info": {
"name": "Computes the Generic Objects to Get from a Specific Objects to Get.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/translate/generic",
"params": [
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Computes the Generic Objects to Get from a Specific Objects to Get."
},
{
"info": {
"name": "Computes the Specific Objects to Get from a Generic Objects to Get.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/translate/specific",
"params": [
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Computes the Specific Objects to Get from a Generic Objects to Get."
},
{
"info": {
"name": "Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/schema/sources/:sourceType/translate/specificWithMappings",
"params": [
{
"name": "accessTokenGuid",
"value": "",
"type": "query",
"description": "The source's access token Guid (if authentified through access token)"
},
{
"name": "username",
"value": "",
"type": "query",
"description": "The source's username (if authentified through OAuth)."
},
{
"name": "passwordGuid",
"value": "",
"type": "query",
"description": "The source's password Guid (if authentified through Basic Auth)"
},
{
"name": "clientId",
"value": "",
"type": "query",
"description": "The source's client id(if authentified through OAuth)."
},
{
"name": "clientSecretGuid",
"value": "",
"type": "query",
"description": "The source's client secret Guid (if authentified through OAuth)."
},
{
"name": "oauthRefreshTokenGuid",
"value": "",
"type": "query",
"description": "The source's refresh token Guid (if authentified through OAuth)."
},
{
"name": "instanceUrl",
"value": "",
"type": "query",
"description": "The source's instance Url."
},
{
"name": "sourceType",
"value": "",
"type": "path",
"description": "The type of the source"
},
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The organization ID"
}
],
"auth": {
"type": "oauth2",
"flow": "authorization_code",
"authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
"accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Computes the Specific Objects to Get from a Generic Objects to Get with a List of Mapping Description"
},
{
"info": {
"name": "Get a Single Source",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update a Source from Simple Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "updateSecurityProviders",
"value": "",
"type": "query"
},
{
"name": "rebuild",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Delete a Source",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Get a Source Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/schedules/:scheduleId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "scheduleId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update a Source Schedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/schedules/:scheduleId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "scheduleId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Delete a Source Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/schedules/:scheduleId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "scheduleId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Get the Raw Configuration of a Source",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/raw",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "includeMappings",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update a Source from Raw Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/raw",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "updateSecurityProviders",
"value": "",
"type": "query"
},
{
"name": "rebuild",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Update Source Permissions",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/permissions/update",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Get a Single Field for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/:fieldId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "fieldId",
"value": "",
"type": "path"
},
{
"name": "includeMappings",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update a Field for an Organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/:fieldId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "fieldId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Removes a Specific Field from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/:fieldId",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "fieldId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Update a Field for an Organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/batch/update",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Subset of Sources for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Optional filter string. Must be at least 2 characters long to be applied."
},
{
"name": "sortingType",
"value": "",
"type": "query"
},
{
"name": "sortingOrder",
"value": "",
"type": "query"
},
{
"name": "writeAccessOnly",
"value": "",
"type": "query"
},
{
"name": "filterStatusType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationResultType",
"value": "",
"type": "query"
},
{
"name": "filterHostType",
"value": "",
"type": "query"
},
{
"name": "stringFilterType",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Create a Source from Simple Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "updateSecurityProviders",
"value": "",
"type": "query"
},
{
"name": "rebuild",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Abort a Source Task Related to a Given Activity.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/tasks/abort",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "activityId",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Stop the Current Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/stopRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Start a Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/startRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Get All Source Schedules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/schedules",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Create a New Schedule for the Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/schedules",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Resume the Current Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/resumeRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Apply a Rebuild Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/rebuild",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Sets the Refreshing State of a Push Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/pushRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "activityOperation",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Pause the Current Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/pauseRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Apply an Incremental Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/incrementalRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Apply a Full Refresh Operation on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/fullRefresh",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Enable Schedules on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/enable",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Duplicate a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/duplicate",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "newSourceName",
"value": "",
"type": "query"
},
{
"name": "logicalIndexId",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\nAND\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Disable Schedules on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/disable",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Evict the Salesforce Schema of a Source.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/configuration/salesforce/evict",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Apply Pending Changes on a Source",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/applyChanges",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Create a Source from Raw Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/raw",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "updateSecurityProviders",
"value": "",
"type": "query"
},
{
"name": "rebuild",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Page Containing a Subset of Sources by Ids for an Organization.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/pages/ids",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Optional filter string. Must be at least 2 characters long to be applied."
},
{
"name": "sortingType",
"value": "",
"type": "query"
},
{
"name": "sortingOrder",
"value": "",
"type": "query"
},
{
"name": "writeAccessOnly",
"value": "",
"type": "query"
},
{
"name": "filterStatusType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationResultType",
"value": "",
"type": "query"
},
{
"name": "filterHostType",
"value": "",
"type": "query"
},
{
"name": "stringFilterType",
"value": "",
"type": "query"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get All Fields for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "query"
},
{
"name": "includeMappings",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Creates a Field for an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Creates Fields for an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/batch/create",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Single Source",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/light",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get the Snapshot of the Source Configuration at the Provided Activity.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/configuration/snapshot",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`"
},
{
"name": "sourceId",
"value": "",
"type": "path",
"description": "The unique identifier of the target [source](https://docs.coveo.com/en/246/).
**Example:** `mycoveocloudv2organizationg8tp8wu3-gravodalyysjsu34camnvxm2d2y`"
},
{
"name": "activityId",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"EDIT\",\"targetId\":\"{sourceId}\"}\n```\n "
},
{
"info": {
"name": "Get an Object Fields for a Given Source.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/configuration/salesforce/objects/:objectName",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "objectName",
"value": "",
"type": "path"
},
{
"name": "relationships",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Relationship for a Given Source and Object.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/configuration/salesforce/objects/:objectName/:relationshipName",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "objectName",
"value": "",
"type": "path"
},
{
"name": "relationshipName",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get an Object Fields for a Given Source.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/:sourceId/configuration/salesforce/objects/:objectName/fields",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "sourceId",
"value": "",
"type": "path"
},
{
"name": "objectName",
"value": "",
"type": "path"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get the Raw Configuration of All Sources",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/raw/all",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "pageSize",
"value": "",
"type": "query"
},
{
"name": "includeMappings",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Page Containing a Subset of Sources for an Organization.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/pages",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Optional filter string. Must be at least 2 characters long to be applied."
},
{
"name": "sortingType",
"value": "",
"type": "query"
},
{
"name": "sortingOrder",
"value": "",
"type": "query"
},
{
"name": "writeAccessOnly",
"value": "",
"type": "query"
},
{
"name": "filterStatusType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationResultType",
"value": "",
"type": "query"
},
{
"name": "filterHostType",
"value": "",
"type": "query"
},
{
"name": "stringFilterType",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Page Containing a Subset of Sources Part of a Project Id. with the Total Number of Sources and the Total Number of Pages",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/pages/project",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Optional filter string. Must be at least 2 characters long to be applied."
},
{
"name": "projectId",
"value": "",
"type": "query"
},
{
"name": "sortingType",
"value": "",
"type": "query"
},
{
"name": "sortingOrder",
"value": "",
"type": "query"
},
{
"name": "writeAccessOnly",
"value": "",
"type": "query"
},
{
"name": "filterStatusType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationType",
"value": "",
"type": "query"
},
{
"name": "filterLastOperationResultType",
"value": "",
"type": "query"
},
{
"name": "filterHostType",
"value": "",
"type": "query"
},
{
"name": "stringFilterType",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get a Page of Fields for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/page/fields",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "projectId",
"value": "",
"type": "query"
},
{
"name": "includeMappings",
"value": "",
"type": "query"
},
{
"name": "type",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Optional filter string. Must be at least 2 characters long to be applied."
},
{
"name": "sortBy",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "page",
"value": "",
"type": "query"
},
{
"name": "perPage",
"value": "",
"type": "query"
},
{
"name": "origin",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Get the Default Document Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/document/configuration/default",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "defaultDocumentConfigurationType",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SOURCE\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n "
},
{
"info": {
"name": "Removes Fields from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/sources/fields/batch/delete",
"params": [
{
"name": "organizationId",
"value": "",
"type": "path"
},
{
"name": "fields",
"value": "",
"type": "query"
}
]
},
"docs": "Privilege required
\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"FIELD\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n "
}
]
}
],
"bundled": true
}