Crowd Bulk Import


In a Nutshell

The Crowd owner can import existing partners into Crowd Workforce by using the basic bulk import function.


Things to Know

Before using this import function, you need to keep the following points in mind:

  • Only API is available to import data.
  • Only SUPERUSER role with admin permission can import data.
  • The data import is asynchronous. If you have large volume of data records to be imported, you are recommended to do so during non-work time.
  • Only import as csv (comma delimited) is supported. CSV UTF-8 is not supported.
  • Depending on the location of the account, requests will be made to one of the following server clusters:
    • EU
    • DE
    • US
    • AU
    • CN

    Account information, including cluster assignment, are obtained from Directory API.

    This information is passed into requests made to the crowd data import API as below:

    https://{cluster}.coresuite.com/cloud-crowd-service/api/crowd/v1/import


How to Import Data

  1. Download partner company bulk import template.
  2. Fill out the data in the template by following these rules:
    • Column fields in the template are fixed. You are not allowed to change its name or order.
    • Column fields with asterisk (*) are mandatory.
    • The ExternalId in the template must be unique.
  3. When the template is ready, use POST endpoint /api/crowd/v1/import to import data. Here is an example:

    {
      curl --location --request POST 'https://eu.coresuite.com/cloud-crowd-service/api/crowd/v1/import?type=PARTNER_DATA_FILE' \
      --header 'Content-Type: multipart/form-data' \
      --header 'Accept: application/json;charset=UTF-8' \
      --header 'Authorization: ' \
      --header 'X-Account-Id: ' \
      --header 'X-Client-ID: ' \
      --header 'X-Company-Id: ' \
      --form 'file=@/path/to/file'
     }
    
  4. If the import is successful, the id will be returned in the response. Please remember the id for further tracking.
  5. Use GET endpoint /api/crowd/v1/import/{id} to get the progress of the import. For details, see Swagger.
  6. When the status is finished, use GET endpoint /api/crowd/v1/import/{id}/report to download the report of the import. For details, see Swagger.
  7. When the partner import is successful, you can start to import technicians.
  8. Download partner technician bulk import template.
  9. Fill out the data in the template by following these rules:
    • Column fields in the template are fixed. You are not allowed to change its name or order.
    • Column fields with asterisk (*) are mandatory.
    • The ExternalId in the template must be unique.
  10. When the template is ready, use POST endpoint /api/crowd/v1/import to import data. Here is an example:

    {
      curl --location --request POST 'https://eu.coresuite.com/cloud-crowd-service/api/crowd/v1/import?type=TECHNICIAN_DATA_FILE' \
      --header 'Content-Type: multipart/form-data' \
      --header 'Accept: application/json;charset=UTF-8' \
      --header 'Authorization: ' \
      --header 'X-Account-Id: ' \
      --header 'X-Client-ID: ' \
      --header 'X-Company-Id: ' \
      --form 'file=@/path/to/file'
    }
    
  11. If the import is successful, the id will be returned in the response. Please remember the id for further tracking.
  12. Use GET endpoint /api/crowd/v1/import/{id} to get the progress of the import. For details, see Swagger.
  13. When the status is finished, use GET endpoint /api/crowd/v1/import/{id}/report to download the report of the import. For details, see Swagger.

Attention:

  • If the external id already exists, the system will overwrite the existing record.
  • Crowd bulk import doesn’t support to import UDF and skills. After you import basic partner and technician data, please use data load to upload UDF and skills.
  • After the partners are imported to Crowd Workforce, the system will automatically create partner admin and send partner portal login information to the partner admin.