Retrieve multiple products based on a MongoDB query

EndpointPOST
https://pinv.dev.att.com/products/find-all
Copy
This endpoint allows you to retrieve a list of TMF637 products from the database by providing a MongoDB-like query in the request body. 
### Features:
- Supports advanced filtering using MongoDB operators such as `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`, `$regex`, and `$elemMatch`.
- Allows pagination using the `limit` and `offset` query parameters.
- Optional functionality to dereference related data using the `should-dereference` query parameter.
- Optionally retrieves the entire ADI package using the `as-adi-package` query parameter.

> **Note**: For more information about MongoDB queries, refer to the [MongoDB Query Documentation](https://www.mongodb.com/docs/manual/tutorial/query-documents/).
Security
httpscheme:bearer
bearerFormat:JWT
Request
Query Parameters
Body Parameters
Responses
Success response
Bodyapplication/json
REQUEST
curl --request POST \
     --url 'https://pinv.dev.att.com/products/find-all?limit=&offset=&should-dereference=&as-adi-package=' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "value.id": "123-4567"
}
'
RESPONSE
{
  "status": 200,
  "timestamp": "2024-11-18T15:25:57.137Z",
  "responseData": [
    {
      "headers": {
        "datacontenttype": "application/json",
        "id": "c31f5942-e198-4272-9811-ce4677d97b77",
        "time": "2024-10-03 12:34:56.123Z",
        "type": "com.att.c360dataPrep.tmf637.post.v5",
        "source": "billing",
        "version": "5",
        "traceparent": "...",
        "tracestate": "..."
      },
      "value": {
        "id": "9ffb3182-409d-48cb-a266-1379117bff58",
        "status": "active",
        "name": "AT&T Dedicated Internet (ADI)",
        "relatedParty": [
          {
            "@type": "RelatedPartyOrPartyRole",
            "role": "Customer",
            "partyOrPartyRole": {
              "@type": "Organization",
              "contactMedium": [
                {
                  "@type": "GeographicAddressContactMedium",
                  "@schemaLocation": "",
                  "contactType": "ServiceAddress",
                  "postCode": "96813",
                  "country": "US",
                  "street1": "502 700 Bishop St Ste",
                  "stateOrProvince": "HI",
                  "city": "Honolulu"
                }
              ],
              "status": "validated",
              "organizationType": "company",
              "isLegalEntity": true,
              "externalReference": [
                {
                  "@type": "ExternalIdentifier",
                  "externalIdentifierType": "CustID",
                  "id": "12349876",
                  "owner": "Instar"
                }
              ],
              "tradingName": "FRIENDLY ARCHITECTS",
              "name": "FRIENDLY ARCHITECTS"
            }
          }
        ],
        "place": [
          {
            "@type": "RelatedPlaceRefOrValue",
            "role": "ServiceAddress",
            "place": {
              "@type": "GeographicAddress",
              "geographicSubAddress": [
                {
                  "@type": "GeographicSubAddress",
                  "buildingName": "",
                  "levelType": "Floor",
                  "levelNumber": "1",
                  "subUnit": [
                    {
                      "@type": "GeographicSubAddressUnit",
                      "subUnitNumber": "123",
                      "subUnitType": "Unit"
                    }
                  ]
                }
              ],
              "streetName": "321 FMO DRIVE",
              "country": "US",
              "city": "TRUE NORTH CITY",
              "postcode": "12345",
              "stateOrProvince": "ZZ"
            }
          }
        ],
        "productCharacteristic": [
          {
            "@type": "StringCharacteristic",
            "name": "Management Option",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Billing Option",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "IP Version",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "WAN IPv4 Block Size",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Additional WAN IPv4 Addresses Needed",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "LanIPv4 Address Block Size",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Additional LAN IP Addresses",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Class of Service",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Class of Service Profile",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Access Speed",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "MBC Speed",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Port Speed",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Interface",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Router Model",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Router Manufacturer",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Vendor",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Service MCN Triplet",
            "value": ""
          },
          {
            "@type": "StringCharacteristic",
            "name": "Access MCN Triplet",
            "value": ""
          }
        ],
        "@type": "ATTProduct",
        "@baseType": "Product",
        "@schemaLocation": "/schema/AttProduct_tmf637.schema.json",
        "externalReference": [
          {
            "@type": "ExternalIdentifier",
            "id": ".BMEC.123456..ATI.",
            "externalIdentifierType": "CircuitID",
            "owner": "INSTAR"
          },
          {
            "@type": "ExternalIdentifier",
            "id": "192837465",
            "externalIdentifierType": "SiteID",
            "owner": "INSTAR"
          }
        ],
        "externalBillingAccountReference": [],
        "productSpecification": {
          "@type": "ProductSpecificationRef",
          "id": "PR-ADI-EMBEDDED-BASE",
          "name": "AT&T Dedicated Internet (ADI)",
          "version": "Embedded Base 1.0"
        },
        "agreementItem": [],
        "realizingService": [
          {
            "@type": "ServiceRef",
            "id": ".BMEC.123456..ATI.",
            "name": "CircuitID"
          }
        ],
        "realizingResource": [
          {
            "@type": "ResourceRef",
            "id": "987654321",
            "name": "PortID"
          },
          {
            "@type": "ResourceRef",
            "id": "1.2.3.4",
            "name": "IPv4"
          },
          {
            "@type": "ResourceRef",
            "id": "1111:abc::de00:23:4567",
            "name": "IPv6"
          },
          {
            "@type": "ResourceRef",
            "id": "1234abcd5678",
            "name": "CPE-SerialNumber"
          }
        ],
        "externalIdentifier": [
          {
            "owner": "provisioning",
            "externalIdentifierType": "id",
            "id": "3036ac98-760b-45e6-9b6d-50cb8cfc08d1"
          }
        ],
        "href": "/products/671b9d13d56f91ccd66e0142"
      }
    }
  ]
}
AT&T DevEx

PINV Capabilities

Retrieve multiple products based on a MongoDB query

Endpoint

http

Query Parameters

Body Parameters

Responses

Body

REQUEST

RESPONSE
