Update VBAInterfaceMapType

Request

Updates a specific VBAInterfaceMapType.

Security

apiKeyAuth and bearerAuth

Path

vBAInterfaceKeyinteger, (int32)required

VBAInterface Key

mapTypestringrequired

Map Type

vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired

vbaInterface_Keyinteger, (int32)required

ID of the VBA interface. Note: This field is marked as NOT NULL in the database and therefore required by the API.

map_Typestring, [ 1 .. 16 ] charactersrequired

Name for the map type.

descriptionstring or null

Description of the map type.

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

surrogate_Map_Typestring or null, <= 16 characters

System Configuration Values used by VBA Engineers to group EDICode Map Types with similar functionality.

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

curl -i -X PUT \
  'https://vbapi.vbasoftware.com/vbasoftware/vba-interfaces/{vBAInterfaceKey}/map-types/{mapType}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "vbaInterface_Key": 0,
    "map_Type": "string",
    "description": "string",
    "entry_Date": "2019-08-24T14:15:22Z",
    "entry_User": "string",
    "surrogate_Map_Type": "string",
    "update_Date": "2019-08-24T14:15:22Z",
    "update_User": "string"
  }'

Responses

Success

Bodyapplication/json

dataobject

errorobject

debugobject

Response

{
  "data": { … },
  "error": { … },
  "debug": { … }
}