Atlas

Appearance

Interface: operations ​

Defined in: packages/redcap-client/src/generated/types.ts:286

Properties ​

request ​

request: object

Defined in: packages/redcap-client/src/generated/types.ts:287

parameters ​

parameters: object

optional cookie?: undefined

parameters.header? ​

optional header?: undefined

parameters.path? ​

optional path?: undefined

parameters.query? ​

optional query?: undefined

requestBody ​

requestBody: object

requestBody.content ​

content: object

requestBody.content.application/x-www-form-urlencoded ​

application/x-www-form-urlencoded: { content: "version"; token: string; } | { content: "project"; token: string; } | { content: "instrument"; token: string; } | { content: "metadata"; token: string; } | { content: "exportFieldNames"; token: string; } | { action: "export"; content: "record"; fields?: string; filterLogic?: string; format: "json" | "csv" | "xml"; forms?: string; rawOrLabel: "raw" | "label"; token: string; type: "flat" | "eav"; } | { action: "import"; content: "RecordImportRequest"; data: string; format: "json" | "csv" | "xml"; overwriteBehavior: "normal" | "overwrite"; returnContent: "count" | "ids" | "auto_ids"; token: string; } | { content: "surveyLink"; instrument: string; record: string; token: string; } | { content: "pdf"; instrument?: string; record: string; token: string; }

Union Members ​
Type Literal ​

{ content: "version"; token: string; }

content ​

content: "version"

Description ​

discriminator enum property added by openapi-typescript

token ​

token: string

Type Literal ​

{ content: "project"; token: string; }

content ​

content: "project"

Description ​

discriminator enum property added by openapi-typescript

token ​

token: string

Type Literal ​

{ content: "instrument"; token: string; }

content ​

content: "instrument"

Description ​

discriminator enum property added by openapi-typescript

token ​

token: string

Type Literal ​

{ content: "metadata"; token: string; }

content ​

content: "metadata"

Description ​

discriminator enum property added by openapi-typescript

token ​

token: string

Type Literal ​

{ content: "exportFieldNames"; token: string; }

content ​

content: "exportFieldNames"

Description ​

discriminator enum property added by openapi-typescript

token ​

token: string

Type Literal ​

{ action: "export"; content: "record"; fields?: string; filterLogic?: string; format: "json" | "csv" | "xml"; forms?: string; rawOrLabel: "raw" | "label"; token: string; type: "flat" | "eav"; }

action ​

action: "export"

Constant ​
content ​

content: "record"

Description ​

discriminator enum property added by openapi-typescript

fields? ​

optional fields?: string

Description ​

Comma-separated list of field names to export

filterLogic? ​

optional filterLogic?: string

Description ​

REDCap filter logic expression (e.g., "[age] >= 18")

format ​

format: "json" | "csv" | "xml"

Default ​
ts
json
@enum {string}
forms? ​

optional forms?: string

Description ​

Comma-separated list of form names to export

rawOrLabel ​

rawOrLabel: "raw" | "label"

Description ​

Return raw coded values or display labels

Default ​
ts
raw
@enum {string}
token ​

token: string

type ​

type: "flat" | "eav"

Description ​

Export format - flat (one row per record) or EAV

Default ​
ts
flat
@enum {string}
Type Literal ​

{ action: "import"; content: "RecordImportRequest"; data: string; format: "json" | "csv" | "xml"; overwriteBehavior: "normal" | "overwrite"; returnContent: "count" | "ids" | "auto_ids"; token: string; }

action ​

action: "import"

Constant ​
content ​

content: "RecordImportRequest"

Description ​

discriminator enum property added by openapi-typescript

data ​

data: string

Description ​

JSON string of records to import

format ​

format: "json" | "csv" | "xml"

Default ​
ts
json
@enum {string}
overwriteBehavior ​

overwriteBehavior: "normal" | "overwrite"

Description ​

normal: only overwrite fields with new values overwrite: overwrite all fields, blanking empty ones

Default ​
ts
normal
@enum {string}
returnContent ​

returnContent: "count" | "ids" | "auto_ids"

Default ​
ts
count
@enum {string}
token ​

token: string

Type Literal ​

{ content: "surveyLink"; instrument: string; record: string; token: string; }

content ​

content: "surveyLink"

Description ​

discriminator enum property added by openapi-typescript

instrument ​

instrument: string

record ​

record: string

token ​

token: string

Type Literal ​

{ content: "pdf"; instrument?: string; record: string; token: string; }

content ​

content: "pdf"

Description ​

discriminator enum property added by openapi-typescript

instrument? ​

optional instrument?: string

record ​

record: string

token ​

token: string

responses ​

responses: object

responses.200 ​

200: object

Description ​

Success - response format varies by content type

responses.200.content ​

content: object

responses.200.content.application/json ​

application/json: string | { creation_time: string; in_production: 0 | 1; project_id: number; project_title: string; record_autonumbering_enabled: 0 | 1; } | { count: number; } | object[] | object[] | object[] | object[]

Union Members ​

string

Type Literal ​

{ creation_time: string; in_production: 0 | 1; project_id: number; project_title: string; record_autonumbering_enabled: 0 | 1; }

creation_time ​

creation_time: string

Description ​

ISO 8601 timestamp of project creation

Example ​
ts
2024-01-15 10:30:00
in_production ​

in_production: 0 | 1

project_id ​

project_id: number

Description ​

Unique project identifier

project_title ​

project_title: string

Description ​

Human-readable project title

record_autonumbering_enabled ​

record_autonumbering_enabled: 0 | 1

Type Literal ​

{ count: number; }

count ​

count: number

Description ​

Number of records imported

object[]

object[]

object[]

object[]

responses.200.content.application/pdf ​

application/pdf: string

responses.200.content.text/plain ​

text/plain: string

responses.200.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.400 ​

400: object

Description ​

Invalid request parameters

responses.400.content ​

content: object

responses.400.content.application/json ​

application/json: object

responses.400.content.application/json.error ​

error: string

Description ​

Error message from REDCap

responses.400.headers ​

headers: object

Index Signature ​

[name: string]: unknown

responses.403 ​

403: object

Description ​

Invalid or missing token

responses.403.content ​

content: object

responses.403.content.application/json ​

application/json: object

responses.403.content.application/json.error ​

error: string

Description ​

Error message from REDCap

responses.403.headers ​

headers: object

Index Signature ​

[name: string]: unknown