Create Table Mapping
  • 04 Jul 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Create Table Mapping

  • Dark
    Light
  • PDF

Article summary

Post
/internal-assets/4.0/table-mapping/{envId}/{assetTemplateId}

Create a new Table Mapping for the specified Asset Template ID.

Notice

Accessing the APIs is through a dedicated domain/URL, according to your PlainID Tenant Location
  • United States (US) - `https://api.us1.plainid.io`
  • Canada (CA) - `https://api.ca1.plainid.io`
  • Europe (EU) - `https://api.eu1.plainid.io`
  • Local PAA - `https://api.plainid.local`


  • cURL Sample Guidelines

    In order for the relevant parameters to appear in the cURL sample, you can input the values in the interactive API console on the right. They will then appear in the cURL sample on the bottom of the page in the correct format.

    Security
    HTTP
    Type bearer

    For more details about Administration API Authentication, check out the Authentication APIs documentation. Provide your bearer token in the Authorization header when making requests to protected resources. Example: Authorization: Bearer 123

    Path parameters
    assetTemplateId
    stringRequired

    The Asset Template ID can be found under the Details tab of the relevant Asset Type.

    envId
    string (uuid) Required

    The Environment ID can be found under the Details Tab in the Environment Settings.

    Body parameters

    Table Mapping to create

    object

    Table mapping

    tableName
    string

    Table Name

    Responses
    201

    Successful operation

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    data
    object (TableMapping)

    Table mapping

    assetTemplateId
    string

    Asset Template ID

    envId
    string (uuid)

    Environment ID

    id
    string (uuid)

    Mapping ID

    tableName
    string

    Table Name

    400

    Table name is not unique

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object

    Error object

    args
    object
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    401

    Unauthorized

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object

    Error object

    args
    object
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    404

    Object not found

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object

    Error object

    args
    object
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer
    500

    Internal Server Error

    Headers
    x-request-id
    string
    The ID of the request
    Expand All
    object

    Response object

    errors
    Array of object (Error)
    object

    Error object

    args
    object
    code
    string
    id
    string
    message
    string
    name
    string
    status
    integer

    Was this article helpful?