Automate

API Changelog

This document contains the major changes in the API in each feature version. For additions to the API, please consult the features added in the main product Changelog, as well as the API Documentation

Version 8.1.0

Objects Changed

Legal Hold
  • Removed property collectionConfigurations
    • Authentication Service
  • Removed property collectionStatus

    • Endpoints Changed

    POST /v1/scheduler/client/matter/{matterId}/allowedSessionParameterValues/workflow/{workflowId}
  • Changed response body from Map<String, List<AllowedValueItem>> to Map<String, List<String>>

    • Endpoints Removed

    GET /v1/scheduler/collections/purview
  • Moved collections to Jobs
    • POST /v1/scheduler/collections/purview
  • Moved collections to Jobs
    • DELETE /v1/scheduler/collections/purview/{purviewCollectionId}
  • Moved collections to Jobs
    • GET /v1/scheduler/collections/purview/{purviewCollectionId}/auditLog
  • Moved collections to Jobs
    • GET /v1/scheduler/collections/purview/{purviewCollectionId}/details
  • Moved collections to Jobs
    • GET /v1/scheduler/collections/purview/submitters
  • Moved collections to Jobs
    • POST /v1/scheduler/collections/purview/{purviewCollectionId}/command
  • Moved collections to Jobs
    • GET /v1/scheduler/legalHold/{legalHoldId}/collectionEvents
  • Moved collections to Jobs
    • GET v1/scheduler/jobs/{id}/relativityServiceUsers
  • Moved to thirdPartyService
    • GET /v1/scheduler/resources/relativityService
  • Moved to thirdPartyService
    • POST /v1/scheduler/resources/relativityService
  • Moved to thirdPartyService
    • PUT /v1/scheduler/resources/relativityService/{relativityServiceId}
  • Moved to thirdPartyService
    • DELETE /v1/scheduler/resources/relativityService/{relativityServiceId}
  • Moved to thirdPartyService
    • POST /v1/scheduler/resources/relativityService/{relativityServiceId}/userCredential
  • Moved to thirdPartyService
    • DELETE /v1/scheduler/resources/relativityService/{relativityServiceId}/userCredential
  • Moved to thirdPartyService
    • POST /v1/scheduler/resources/relativityService/{relativityServiceId}/userCredential/test
  • Moved to thirdPartyService
    • POST /v1/users/oidcNonce
  • Updated OIDC login logic
    • POST /v1/users/oidcMicrosoftAuth
  • Updated OIDC login logic
    • POST /v1/scheduler/users/userService/{userServiceId}/eDiscoveryApiProxy
  • Updated OIDC login logic
    • POST /v1/scheduler/users/userService/{userServiceId}/eDiscoveryApi
  • Updated OIDC login logic
    • DELETE /v1/scheduler/users/userService/{userServiceId}/eDiscoveryManager
  • Updated OIDC login logic

    • Version 7.4.0

    Objects Changed

    Event Trigger Type
  • Renamed enum JOB_ADDED to JOB_SUBMITTED

    • Endpoints Changed

    GET /v1/scheduler/resources/dataRepository/{dataRepositoryId}/files
  • Added query parameters includeFiles and allowedFileExtensions
  • Changed response body type from application/json to application/octet-stream
    • GET /v1/scheduler/resources/dataRepository/{dataRepositoryId}/fileSize
  • Changed response body type from application/json to application/octet-stream
    • POST /v1/scheduler/client/matter/{matterId}/allowedSessionParameterValues/workflow/{workflowId}
  • Changed response body from Map<String, List<String>> to Map<String, List<AllowedValueItem>>

    • Version 7.3.0

    Objects Changed

    Event Type
  • Renamed enums PROCESSING_JOB_... to JOB_...
  • Renamed enums PROCESSING_SCHEDULE... to SCHEDULE_...
  • Renamed enums COLLECTION_JOB_... to COLLECTION_...
    • Event Trigger Type
  • Renamed enum PROCESSING_JOB to JOB
  • Renamed enum PROCESSING_SCHEDULE to SCHEDULE
  • Renamed enum COLLECTION_JOB to COLLECTION

    • Endpoints Changed

    GET /v1/media/operationIcon/{operationAlias}
  • Renamed path parameter operationName to operationAlias
    • GET /v1/users/oidcMicrosoftAuth
  • Removed properties eDiscoveryManagerLogin, sensitive
    • POST /v1/scheduler/util/resolve/multiple
  • Renamed property processingJobId to jobId
    • * /v1/scheduler/util/resolve/processingJob/{name}
  • Renamed to /v1/scheduler/util/resolve/job/{name}
    • * /v1/scheduler/collections/purview/*
  • Renamed property processingJobOptions to jobOptions
  • Renamed property processingJobOperation to jobOperation

    • Version 7.2.0

    Objects Changed

    Parameter
  • Added properties parameterType, userDisplayableValue, displayCondition, relativityCondition
  • Removed properties type, sensitive
    • LicenceInfo
  • Added property thirdPartyLicenses

    • Version 7.1.0

    Endpoints Changed

    POST /v1/scheduler/library/workflow
  • Renamed query parameter overwriteExisting to updateExisting