Please enable JavaScript to view this site.

PRIM Help

 

 

WARNING: This section is intended for advanced users and "Super users" of PRIM Logix.

 

The configuration items presented in this section may indeed have an impact on your operations.

 

If in doubt, consult your system administrator.

 

Please note that only users in the appropriate security groups can access the software configuration windows.

 

Get a PRIM data export file



Triggers data export from PRIM. At the end of the process (which can take up to 5 minutes), a URL will be returned indicating the file to download.

URL: api/GetFileExportData

 

Attributes to pass to actionParameters


 

ExportDivision

integer

Mandatory

Division ID (divcod)

Possible values: 1 or higher


 

ExportType

integer

Mandatory

Type of requested data (idtcod)

Possible values:  

Type

Description

1500

Candidate

1502

Client

1505

Shift

1504

Job offer


 

ExportListCode

integer

Optional

ID of the list to export

Possible values: null (takes the value defined in the export template) or 1 and higher


Important

An export template and the export protocole must be configured beforehand for this Web service to work.

Complete example:

{
    "actionParameters":
    {
        "ExportDivision": 61,
        "ExportType": 1500,
        "ExportListCode": null
    }
}

Response returned by Web service


{
    "status": "success",
    "data": {
        "link": "https://<client>.primlogix.com/uploads/<clicod>_<ciecod>_<numero>.<file type>"
    }
}

Here is what each field returned by the data property corresponds to:


 

link

string

URL to retrieve the export file


Created with Help+Manual 8 and styled with Premium Pack Version 4 © by EC Software