Jump to

• Request
• Response
• Examples

Lookup Asset ID

get

/mobile/tools/1.0/assets/lookup

Returns the ID of the asset that's identified by its name and version.

Request

Supported Media Types

• application/json

Query Parameters

• fqn: string
  Full name and version of the asset in the format namespace/name(version) for APIs and connectors, and name(version) for other asset types.
• type: string
  The asset's type.

  Allowed Values: [ "API", "MobileBackend", "Connector", "APIImplementation", "Client", "StorageCollection", "Package" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Asset metadata.

Headers

• ETag: string
  The ETag corresponds to the state of the asset (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.

Body ()

Asset information (short form).

Root Schema : assetShort

Type: object

Asset information (short form).

Show Source

• id(optional): string
  Asset identifier.
• name(optional): string
  Asset name.
• namespace(optional): string
  Asset namespace.
• version(optional): string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"Asset information (short form).",
    "type":"object",
    "properties":{
        "name":{
            "description":"Asset name.",
            "type":"string"
        },
        "namespace":{
            "description":"Asset namespace.",
            "type":"string"
        },
        "id":{
            "description":"Asset identifier.",
            "type":"string"
        },
        "version":{
            "description":"Asset version.",
            "$ref":"#/definitions/version"
        }
    }
}

404 Response

An asset with the specified name and version doesn't exist.

Body ()

Root Schema : error

Type: object

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  The service's error code.
• o:errorDetails(optional): object errorDetails
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer(int64)
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• detail: string
• o:errorDetails(optional): object errorDetails
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

Back to Top

Examples

This example shows how to get the ID of an asset that's identified by its name and version. It gets the ID of the asset that's of type API, is in the custom namespace, is version 1.0, and is named incidentreport.

curl -i -X GET  -H "Authorization: Bearer $TOKEN" \
"$BASE_URL/mobile/tools/1.0/assets/lookup?type=API&fqn=custom/incidentreport(1.0)"

Example of Response Header

Here's an example of the response headers.

200 OK
Content-Length: 85
Content-Type: application/json
Date: Tue, 10 Jul 2018 00:46:31 GMT

Example of Response Body

Here's the contents of the response body.

{
    "id": "ce6b3adb-4c8d-47d7-98ab-95b15f2db00f",
    "name": "incidentreport",
    "version": "1.0"
}

Back to Top