BusinessMode
Sign inGet started

Preview a CSV roster

Seats · previewRosterCsv

Accepts text/csv up to 1 MiB and at most 1000 data rows. This operation does not mutate seats.

POST/projects/{projectId}/licenses/{licenseId}/roster-preview

Base URL: https://api.businessmode.io/v1

Authentication

Developer bearer token

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

NameInRequiredType and constraints
projectIdpathYesstringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
licenseIdpathYesstringFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Request body

Required

text/csv

string · RosterCsv
  • Maximum length: 1048576

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

200 Successful response.

Content type: application/json

object · RosterPreviewResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
alreadyAssignedarrayYes
View nested schema
array
Array items
object
  • No additional properties
FieldTypeRequiredDescription / constraints
externalUserIdstringYesMinimum length: 1 · Maximum length: 512
idstringYesFormat: uuid · Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
availableSeatCountintegerYesMinimum: 0 · Maximum: 9007199254740991
blockingReasonanyOfYes
View nested schema
anyOf

anyOf · 2 alternatives

Alternative 1
string
  • Values: invalid_roster, license_inactive, seat_limit_exceeded
Alternative 2
null
capacitySufficientbooleanYes
currentAssignedCountintegerYesMinimum: 0 · Maximum: 9007199254740991
errorCountintegerYesMinimum: 0 · Maximum: 1000
errorsarrayYes
View nested schema
array
Array items
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesValues: missing_external_user_id, invalid_external_user_id, duplicate_external_user_id
rowintegerYesMinimum: 2 · Maximum: 9007199254740991
externalUserIdsarrayYes
View nested schema
array
Array items
string
  • Minimum length: 1
  • Maximum length: 512
licenseAssignablebooleanYes
rowCountintegerYesMinimum: 0 · Maximum: 1000
seatLimitintegerYesMinimum: 0 · Maximum: 9007199254740991
validCountintegerYesMinimum: 0 · Maximum: 1000
wouldAssignCountintegerYesMinimum: 0 · Maximum: 1000
wouldAssignExternalUserIdsarrayYes
View nested schema
array
Array items
string
  • Minimum length: 1
  • Maximum length: 512

400 Invalid request.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

401 Authentication failed.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

404 The authorized resource was not found.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

429 Too many requests. Honor Retry-After before retrying with the same logical Idempotency-Key, where required. Known error codes: rate_limit_exceeded.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

500 An unexpected server error occurred.

Content type: application/json

object · ErrorResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
errorobjectYesNo additional properties
View nested schema
object
  • No additional properties
FieldTypeRequiredDescription / constraints
codestringYesMinimum length: 1
messagestringYesMinimum length: 1

Understand the Seats concept →

← All API operations