Import File

POST /public/v1/projects/{projectId}/import
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
application/json

Body Required

  • files array[object]
    Hide files attributes Show files attributes object
    • importId string(uuid)
    • fileId string(uuid)
    • name string
    • dataDate string(date-time)
    • contractualEndDate string(date-time)
    • skipSubsetValidations boolean
    • importLogHitRateGoal integer(int32)
  • sendNotification boolean

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • files array[object] Required

      List of Imported Files

      Hide files attributes Show files attributes object
      • fileId string(uuid)
      • importId string(uuid)
      • valid boolean
      • errors array[string]
    • importId string(uuid) Required

      Import ID

    • message string Required

      Import Message

    • status string Required

      Import Status

      Values are Queued or Failed.
POST /public/v1/projects/{projectId}/import 
curl \
 --request POST 'https://live.smartpmtech.com/public/v1/projects/{projectId}/import' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-COMPANY-ID: string" \
 --data '{"files":[{"importId":"string","fileId":"string","name":"string","dataDate":"2025-05-04T09:42:00Z","contractualEndDate":"2025-05-04T09:42:00Z","skipSubsetValidations":true,"importLogHitRateGoal":42}],"sendNotification":true}'
Request examples 
# Headers
X-COMPANY-ID: string

# Payload
{
  "files": [
    {
      "importId": "string",
      "fileId": "string",
      "name": "string",
      "dataDate": "2025-05-04T09:42:00Z",
      "contractualEndDate": "2025-05-04T09:42:00Z",
      "skipSubsetValidations": true,
      "importLogHitRateGoal": 42
    }
  ],
  "sendNotification": true
}
Response examples (500) 
{}
Response examples (200) 
{
  "files": [
    {
      "fileId": "string",
      "importId": "string",
      "valid": true,
      "errors": [
        "string"
      ]
    }
  ],
  "importId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Import completed successfully.",
  "status": "Queued"
}