Follow

New API Method «LaunchScheduledImport» is Ready!!!

Description:

This new API Method will allow you to trigger an interface-preconfigured-import on demand!
Particularily useful for clients in need of importing large files on demand into the ContactList table or any Relational table of a project.

How to make it work?

1- Go to the interface an elaborate a new pre-configured import, make sure it is activated and that "Remote launch (by client)" is checked.
2- Trigger this Method from a call

Prototype:

ImportResult LaunchScheduledImport (RemoteID ID, ProjectID Project, int IdScheduledImport, string Path)

Parameters:

ID

 

 

RemoteID,

Allows authentication of the user making the call

Project

 

 

ProjectID

Allows the identification of the Project corresponding to the preconfigured automated import

IdScheduledImport

 

 

int

Unique (Id) of the preconfigured auto import to execute

Path

 

 

String,

(Optional). Access path to the file that should be imported.

If you write a null value or an empty string there, then the default path, inserted into the preconfigured auto import will be taken.

In the contrary, when this parameter is supplied with a valid path, then it replaces the default path, just for this time!.

3 Comments

  • Avatar
    Ofsys Master

    The web service would always return « Success » if the request was received properly, but that doesnt mean that the Import worked.

    It only means that the REQUEST to launch the import was received and processed.

    The rest depends on the task itself, that gets executed AFTER the API call ends.

  • Avatar
    Ofsys Master

    The Service works like that : 

    1-      Call the Service « Launch On Demand ».

    1. Returns the import ID

    There's a success if the Import was able to launch successfully. We don't wait until the import is finished in order to send the answer.  This is because the import could take several minutes.

    2-      Call Service "Status" in loop. (until status whifts to "Finished")

    1. Returns the current "Status", "Finished", etc. as well as an error Message in case of errors.
  • Avatar
    Ofsys Master

    In case of a file not located on our FTP, the “filepath” used in the call needs to be an FTP path that is relative to the root directory of the FTP server selected in that import task.

    Client needs to put the file on the server first, and then call that service with the actual FTP path where he uploaded it.

Please sign in to leave a comment.