Overview of commands and REST API endpoints

Each command that you enter by using the import CLI uses a REST API endpoint. The following table provides an overview of all commands that the import CLI accepts and the appropriate REST API endpoint call.

Registering and unregistering a client

Task Command REST API endpoint call
Register a client siq4l client register deployment_type

For more information about this command, see Registering a client with the REST API.

 
POST /security/registerClient
{
“scopes”: scopelist,
“remoteaddrs”: ipaddress-list,
“loginids”: signinid-list,
}
Example:
POST /security/registerClient
{
“scopes”: ["import","attachment"],
“remoteaddrs”: "127.0.0.1"
“loginids”: ["procadmin","paralegal1"],
}

A JSON file is returned, which contains the key and the secret. Store the file in a safe place.
Unregister a client siq4l client unregister

For more information about this command, see Registering a client with the REST API.

 
POST /security/unregisterClient
{
“key”: "client-key",
“secret”: "client-secret",
}

Commands for creating and managing the import mappings

Task Command REST API endpoint call
List all target entities that StoredIQ® for Legal supports siq4l importmapping list-target-entities

For more information about this command, see Creating the import mapping.

 GET /import/mappings/targetentities
List all available mappings, together with their mapping IDs siq4l importmapping list

For more information about this command, enter the following command:
siq4l importmapping list --help

 GET /import/mappings
Make a new mapping available for use siq4l importmapping define

For more information about this command, see Creating the import mapping.

 POST /import/mappings/mappingid
Make a changed mapping available for use siq4l importmapping update

For more information about this command, enter the following command:
siq4l importmapping update --help

 PUT /import/mappings/mappingid
Retrieve a mapping by its ID siq4l importmapping get

For more information about this command, enter the following command:
siq4l importmapping get --help

 GET /import/mappings/mappingid
Retrieve a default mapping for a specific target entity siq4l importmapping get-default

For more information about this command, see Creating the import mapping.

 GET /import/mappings/defaults/targetentityname
Retrieve a mapping template for a specific target entity siq4l importmapping get-template

For more information about this command, see Creating the import mapping.

 GET /import/mappings/templates/targetentityname
Delete a mapping siq4l importmapping delete

For more information about this command, enter the following command:
siq4l importmapping delete --help

 DELETE /import/mappings/mappingid

Commands regarding the import of data

Task Command REST API endpoint call
Import data siq4l importrequest run

For more information about this command, see Importing the data by using the command line.

 The following series of calls:
  1. POST /import/requests
  2. POST /import/requests/requestid/start
  3. GET /import/requests/requestid/status
    Repeat this call until the status is COMPLETE or FAILED.
List all import requests siq4l importrequest list

For more information about this command, enter the following command:
siq4l importmapping list --help

 GET /import/requests
Retrieve a specific import request siq4l importmapping get

For more information about this command, enter the following command:
siq4l importmapping get --help

 GET /import/requests/requestid
Delete an import request siq4l importmapping delete

For more information about this command, enter the following command:
siq4l importmapping delete --help

 DELETE /import/requests/requestid

Cleaning up history-related data

Task Command REST API endpoint call
Clean up the department hierarchy siq4l orgtree cleanup nodes

For more information about this command, see Cleaning up organization hierarchy data.

 
POST /orgtreenodes/cleanup
{"datefrom": "timestamp"}
Example:
POST /orgtreenodes/cleanup
{"datefrom": "2014-01-01T00:00:00Z"}
Clean up the employment history siq4l orgtree cleanup members

For more information about this command, see Cleaning up organization hierarchy data.

 
POST /orgtreemembers/cleanup
{"datefrom": "timestamp"}
Example:
POST /orgtreemembers/cleanup
{"datefrom": "2014-01-01T00:00:00Z"}
Clean up the person history siq4l persondistincthistory cleanup

For more information about this command, see Cleaning up person information.

 
DELETE /personhistory