Contents x
    Delete API Mapping
    • 24 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Delete API Mapping

    • Updated on 24 Nov 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Delete
    /internal-assets/4.0/api-mapping/{envId}/{assetTemplateId}/{attributeKey}

    This Delete Request deletes all the API Mappers under the specified Attribute.
    If you wish to delete a specific API Mapper, include the Application Matcher ID or Application Name and Application Matcher Name.

    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`


    • Using HTML Encoded Special Characters

    Use HTML encoded patterns when working with values that contain special characters like spaces, dashes, etc. Refer to this HTML URL Encoding Reference for a full list.


    Important note about headers


    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.

    attributeKey
    stringRequired

    To locate the Attribute Key, select the relevant Asset Type and click on Asset Attributes.

    Query parameters
    filter[applicationMatcherId]
    string

    Filter to apply on the Application Matcher ID.

    filter[applicationName]
    string

    Filter to apply on the Application Name.

    filter[applicationMatcherName]
    string

    Filter to apply on the Application Matcher Name.

    filter[source]
    string

    Filter to apply on the Source.

    filter[path]
    string

    Filter to apply on the Path.

    Responses
    200

    Successful operation

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

    Response object

    data
    Array of object (MappingId)
    object

    Mapping ID

    id
    string (uuid)

    Mapping ID

    400

    Attribute key is not unique

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

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    401

    Unauthorized

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

    Response object

    errors
    Array of object (Error)
    object
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    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
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    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
    code
    string
    id
    string
    status
    integer
    name
    string
    message
    string
    args
    object
    path
    string
    Was this article helpful?
    What's Next