Récupération des actifs

L'API Assets (V1) permet à un utilisateur disposant de l'autorisation View Install Base de rechercher des actifs installés sur la base d'un critère donné, et d'obtenir des détails spécifiques sur les actifs.

Conditions préalables

Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.

Recherche de biens et de données sur les biens

Pour rechercher des informations sur les actifs, envoyez une requête POST au point de terminaison /assets/search. Spécifiez vos critères de recherche dans le corps de la requête. Vous pouvez également spécifier le comportement de recherche dans les paramètres de la requête.

POST /v1/assets/searchView the API Reference
Method	POST
URL or End Point	/v1/assets/search
Headers	Content-Type
Query Parameters	sorts, source, q, exactMatch
Body Parameters	filter {ibxs [string], cages [string], productTypes [string], dateRange {fromDate, toDate}}

Exemple de requête cURL :

Cette requête indique qu'une recherche de panneaux de brassage dans l'emplacement IBX, DA1 ; dans la cage, DA1:01:009800 ; et installés entre les dates 17/07/2003 et 17/07/2019 a été effectuée. Les résultats de la recherche ont été triés par numéro de série croissant, filtrés pour les panneaux de brassage dont le numéro d'actif comprenait 101, sélectionnés pour commencer à partir de l'index 0, et limités à 100 résultats par page.

curl -X  
POST "https://api.equinix.com/v1/assets/search?sorts=SERIAL_NUMBER&source=ASSET_NUMBER&q=101&exactMatch=false&offset=0&limit=100"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"  
-d '{  
    "filter": {  
        "ibxs": [  
            "DA1"  
        ],  
        "cages": [  
            "DA1:01:009800"  
        ],  
        "productTypes": [  
            "PATCH_PANEL"  
        ],  
        "dateRange": {  
            "fromDate": "2003-07-17T03:31:20.455Z",  
            "toDate": "2019-07-17T03:31:20.455Z"  
        }  
    }

Exemple de réponse :

{  
    "data": [  
      {  
        "assetNumber": "10139297",  
        "serialNumber": "PP:0210:73281",  
        "orderNumber": 1-126273059,  
        "productName": "PATCH_PANEL",  
        "ibx": "DA1",  
        "cage": "DA1:01:009800",  
        "productDescription": "Patch Panel",  
        "accountNumber": "987",  
        "relatedAccountNumber": null,  
        "accountName": "JOHN-DOE-CORP",  
        "installationDate": "2009-05-14T00:00:00Z",  
        "customerReferenceNumber": DAY-98278,  
        "billingAgreementNumber": CAB-93678,  
        "status": "ACTIVE",  
        "additionalDetails": {  
            "cabinetNumber": "DA1:01:009800:0210",  
            "customerOrCarrierCircuitID": null,  
            "finalzSideSystemName": null,  
            "productBundle": null,  
            "patchPanelNumber": "PP:0210:73281"  
      }  
    },  
    {  
        "assetNumber": "10147789",  
        "serialNumber": "VP:0101:74679",  
        "orderNumber": null,  
        "productName": "PATCH_PANEL",  
        "ibx": "DA1",  
        "cage": "DA1:R1:V000170-1-294",  
        "productDescription": "Patch Panel",  
        "accountNumber": "987",  
        "relatedAccountNumber": null,  
        "accountName": "JOHN-DOE-CORP",  
        "installationDate": "2009-07-09T00:00:00Z",  
        "customerReferenceNumber": null,  
        "billingAgreementNumber": null,  
        "status": "ACTIVE",  
        "additionalDetails": {  
            "cabinetNumber": "DA1:R1:V000170-1-294:V1801",  
            "customerOrCarrierCircuitID": null,  
            "finalzSideSystemName": null,  
            "productBundle": null,  
            "patchPanelNumber": "VP:0101:74679"  
        }  
      }  
    ],  
    "page": {  
        "limit": 100,  
        "offset": 0,  
        "total": 2,  
        "sorts": [  
        "SERIAL_NUMBER"  
       ]  
    },  
    "_links": {  
        "next": {  
           "href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"  
        },  
        "previous": {  
           "href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"  
        },  
        "self": {  
           "href": "/assets/search?q=101&exactMatch=false&offset=0&limit=100&source=ASSET_NUMBER&sorts=SERIAL_NUMBER"  
        }  
    }  
}

Pour obtenir la liste complète des paramètres de réponse, consultez la Référence API.

Obtenir des actifs

Pour obtenir tous les détails d'un actif spécifique, envoyez une requête GET au point de terminaison /assets/{assetId}. Spécifiez l'identifiant de l'actif dans le chemin de la requête.

curl -X  
GET "https://api.equinix.com/v1/assets/{asset_id}"  
-H "content-type: application/json"  
-H "authorization: Bearer <token>"

Exemple de réponse :

{  
    "assetNumber": "9980813",  
    "serialNumber": "1011585-M",  
    "orderNumber": "1-198255055853",  
    "productName": "CROSS_CONNECT",  
    "ibx": "DC4",  
    "cage": "DC4:01:043325",  
    "productDescription": "Network Cable Connection",  
    "accountNumber": "888",  
    "accountName": "JOHN-DOE-CORPORATION",  
    "installationDate": "2008-08-28T00:00:00Z",  
    "customerReferenceNumber": "",  
    "status": "Active",  
    "productDetails": [  
        {  
            "key": "ACCOUNT_NAME",  
            "value": "JOHN-DOE-CORPORATION",  
            "tag": "HEADER"  
        },  
        {  
            "key": "CUSTOMER",  
            "value": "JOHN-DOE-CORPORATION",  
            "tag": "A_SIDE_INFORMATION"  
        },  
        {  
            "key": "ASSET_NUMBER",  
            "value": "9980813",  
            "tag": "OTHER_DETAILS"  
        },  
        {  
            "key": "IFC_PANEL",  
            "value": "No",  
            "tag": "Z_SIDE_INFORMATION"  
        }  
    ]  
}

Pour obtenir la liste complète des paramètres de réponse, consultez la Référence API.