System API : System Controller

The System APIs are used to maintain basic functions such as running or creating jobs, clearing the system cache, running reports, and manage the various languages available for the UI.

In addition, you can use the System APIs to:

  • Check the system status

  • Maintain transmission options

  • Initiate workflows

  • Monitor server properties

  • View job history

  • Migrate objects in or out of the system

For more detailed information, see the System API Endpoints section below or the EnterWorks Swagger pages.

System API Endpoints

GET /api/config/properties:

  • Retrieves the configuration properties defined in the sharedConfig.properties file.

    Note: If the configName parameter is empty then all properties will be returned.

POST /api/customJob/AMQPCustomJob:

  • Creates a custom AMQP job using the specified values.

GET /api/epxTasks:

  • Retrieves the epx workflow list.

POST /api/epxTasks/{taskId}/start:

  • Kicks off the epx system workflow that was configured in the shared configuration property file.

GET /api/fileEncodings:

  • Retrieves a list of file encoding options.

DELETE /api/jobs:

  • Deletes a list of specified jobs.

GET /api/jobs:

  • Retrieves the specified job listings.

    Note: The AdditionalXmlData field is converted to JSON string if the job type is set to "custom". This field is set to XML string for all other job types.

PATCH /api/jobs:

  • Patches the specified jobs.

    Note: Use ABORT to stop a job. Use END if there is an error with the job status and it needs to be cleared.

GET /api/jobs/{jobId}:

  • Retrieves the specified job (jobId).

GET /api/jobs/{jobId}/history:

  • Retrieves the history for the specified job (jobId).

GET /api/jobs/{jobId}/transmitFile:

  • Transmits the file created by the specified job (jobId).

GET /api/languages:

  • Retrieves a list of all active and inactive languages in the system.

POST /api/languages:

  • Creates a new language in the system and assign groups.

DELETE /api/languages/{languageId}:

  • Deletes the specified language (languageId).

GET /api/languages/{languageId}:

  • Retrieves the specified language (languageId).

PUT /api/languages/{languageId}:

  • Updates the specified language (languageId).

GET GET /api/logOut:

  • Enables the user to log out of the application.

GET /api/loggedInUsers:

  • Retrieves a list of users who have logged in during the past 24 hours.

GET /api/messages:

  • Retrieves a list of labels and properties from the messages based off the specified language (languageId).

    Note: The default behavior is to return the default language properties.

POST /api/migrateIn:

  • Creates a "migrate in" job.

    Note: The job ID will be returned. If the migrationObjMap value is empty, nothing will be returned.

GET /api/migrateInMsfFiles:

  • Retrieves migrate in specification files.

GET /api/migrateInObjs:

  • Retrieves migrate in objects from the specified zip file (zipFileName).

GET /api/migrateInZipFiles:

  • Retrieves migrate in zip files.

POST /api/migrateOut:

  • Creates a "migrate out" job.

    Note: The job ID will be returned. If the migrationObjMap value is empty, nothing will be returned.

GET /api/migrateOutObjs:

  • Retrieves the migrate out objects.

POST /api/server/clearCache:

  • Clears the server cache.

GET /api/server/properties:

  • Retrieves a list of server properties.

GET /api/sharedConfigurations:

  • Retrieves a paged list of shared configurations.

GET /api/sysem/build/version:

  • Clears the server cache.

POST /api/system/check:

  • Retrieves a list of system status types.

POST /api/system/report/attrFilter:

  • Retrieves the report data for a specified repository attribute filter (attributeId).

POST /api/system/report/linkedContent:

  • Retrieves the report data for the specified linked content (linkId).

POST /api/system/report/linkedRepoContent:

  • Retrieves report data for repository linked content from the Home page.

    Note: Same as /system/reports/linkedContent except the data is returned in a different format.

POST /api/system/report/repoStatus:

  • Retrieves report data on the repository status from the Home page.

GET /api/transmissions:

  • Retrieves a list of transmission options.