May 26, 2024
ALM Catalog Data Extraction: How to Retrieve All Catalog Information using API
Comments
(0)
May 26, 2024
ALM Catalog Data Extraction: How to Retrieve All Catalog Information using API
https://www.linkedin.com/in/anupam-gogoi-97a14888/
Wizard
Followers: 22 people
(0)
    • GET /catalogs

      • Retrieves a list of catalogs

      Implementation Notes

      Get a list of all catalogs for an ALM account.

      Response Class (Status 200)

      Operation successful

      • Example Value
      {
        "data": [
          {
            "id": "string",
            "type": "string",
            "attributes": {
              "dateCreated": "string",
              "dateUpdated": "string",
              "description": "string",
              "imageUrl": "string",
              "isDefault": true,
              "isInternallySearchable": true,
              "isListable": true,
              "name": "string",
              "state": "string"
            }
          }
        ]
      }
          application/vnd.api+json;charset=UTF-8

      Parameters

      Parameter Value Description Parameter Type Data Type
      0 Mention the starting range value of the records to be displayed in page query integer
      3 Mention the maximum number of records to be displayed per page. Max allowed is 10 query integer
                        name  (default)            -name            dateCreated            -dateCreated            dateUpdated            -dateUpdated Choose the type of sorting to be applied to the results. Sorting based on recommendation score will only be applicable for PRL enabled LOs query string
      Mention ids of catalogs for which data is being requested.Max allowed number of ids that can be included is 10 query Array[]

      Response Messages

      HTTP Status Code Reason Response Model Headers
      400 A generic http bad request error
      {
        "meta": {
          "error": "string",
          "detail": "string"
        }
      }
      401 A generic http unauthorized access error. Access is denied due to invalid credentials
      {
        "meta": {
          "error": "string",
          "detail": "string"
        }
      }

      Curl 

      curl -X GET --header 'Accept: application/vnd.api+json' --header 'Authorization: oauth 2fd348739caecd258732b6wdwdd01ad4fe6e2063' 'https://learningmanager.adobe.com/primeapi/v2/catalogs?page[offset]=0&page[limit]=3&sort=dateCreated'

      Request URL 

      https://learningmanager.adobe.com/primeapi/v2/catalogs?page[offset]=0&page[limit]=3&sort=dateCreated

      Response Body 

      {
        "links": {
          "self": "https://learningmanager.adobe.com/primeapi/v2/catalogs?page[offset]=0&page[limit]=3&sort=dateCreated",
          "next": "https://learningmanager.adobe.com/primeapi/v2/catalogs?page[offset]=3&page[limit]=3&sort=dateCreated"
        },
        "data": [
          {
            "id": "136838",
            "type": "catalog",
            "attributes": {
              "dateCreated": "2022-01-12T19:22:12.000Z",
              "dateUpdated": "2024-05-07T17:17:19.000Z",
              "description": "Collection of all the learning objects in your account. The contents of this catalog cannot be shared externally and are visible to all Learners by default.",
              "isDefault": true,
              "isInternallySearchable": true,
              "isListable": true,
              "name": "Default Catalog",
              "state": "Enabled"
            }
          },
          {
            "id": "137608",
            "type": "catalog",
            "attributes": {
              "dateCreated": "2022-01-25T09:47:27.000Z",
              "dateUpdated": "2022-06-29T00:39:57.000Z",
              "description": "Test cat for target audience",
              "imageUrl": "https://cpcontents.adobe.com/protected/account/108079/thumbnails/catalogs/137608/profitable-company-director-successful-entrepreneur-professional-leadership-high-income-enterprise-owner-financial-success-achievement_335657-2354_e5bc355760e04b5dbbe552dac5d5a45f.png?cp_oauth_jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwIjoidXJsIiwicmFuZCI6IjliODlmZWU4NjFjYzdlNmIwZGI1ZDUwYjIwMTA4YTI1IiwidiI6IjEiLCJvcmlnaW5hbFVybEhhc2giOiI5ZWM1YjI3OTU2NzBhYzkwYWU0Y2VlNjgxODMzOTU2NDkyMzk5MGQ3IiwiZXhwIjoxNzE3MzQxNDMwLCJyaWQiOiIxNjI0NTU4MyIsImlhdCI6MTcxNjczNjYzMCwiY2lkIjoiMSJ9.TfxVReLsRbUzKy3hMCAleLmNbXy6X8Qw_usxtI34-Uk",
              "isDefault": false,
              "isInternallySearchable": true,
              "isListable": true,
              "name": "AnupamCAT",
              "state": "Disabled"
            }
          },
          {
            "id": "137630",
            "type": "catalog",
            "attributes": {
              "dateCreated": "2022-01-25T14:22:00.000Z",
              "dateUpdated": "2022-06-29T00:39:54.000Z",
              "description": "Sharing Catalog Externally to Raji",
              "imageUrl": "https://cpcontents.adobe.com/protected/account/108079/thumbnails/catalogs/137630/background-travel-the-map-classroom-example-1024x706_750907cfffcd498c9be51e098a75c225.png?cp_oauth_jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwIjoidXJsIiwicmFuZCI6IjliODlmZWU4NjFjYzdlNmIwZGI1ZDUwYjIwMTA4YTI1IiwidiI6IjEiLCJvcmlnaW5hbFVybEhhc2giOiJhNzUzMmIzMTEwNGY4NjM2NDQxODI5OGNmMjNhMTMzMGJkZDhkZDI3IiwiZXhwIjoxNzE3MzQxNDMwLCJyaWQiOiIxNjI0NTU4MyIsImlhdCI6MTcxNjczNjYzMCwiY2lkIjoiMSJ9.1JoP6QBH41RFM4o3hoKvIsMaZ5NcHlkVGHkdGWLWSpM",
              "isDefault": false,
              "isInternallySearchable": true,
              "isListable": true,
              "name": "Anup2Raji",
              "state": "Disabled"
            }
          }
        ]
      }

      Response Code

      200

      Response Headers

      {
        "access-control-allow-credentials": "true",
        "access-control-allow-headers": "X-acap-all-roles, X-acap-account,X-acap-user,X-acap-caller-role,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type, x-experience-api-version, Authorization, X-CSRF-TOKEN, X-HTTP-Method-Override, X-acap-ug-manager-scope, X-acap-extension-token",
        "access-control-allow-methods": "GET, POST, OPTIONS, PUT, HEAD, DELETE, PATCH",
        "access-control-expose-headers": "Requested-Accept-Language, x-rate-limit, x-burst, x-excess-requests-per-second, Retry-After",
        "content-encoding": "gzip",
        "content-type": "application/vnd.api+json;charset=UTF-8",
        "date": "Sun, 26 May 2024 15:17:10 GMT",
        "requested-accept-language": "en-US,en;q=0.9",
        "server": "openresty",
        "server-timing": "server_resp;dur=15",
        "strict-transport-security": "max-age=31536000; includeSubDomains",
        "x-content-type-options": "nosniff",
        "x-frame-options": "SAMEORIGIN",
        "x-request-id": "gwc5bb139b6f30604fe0ewddwc5b43fa3de1d7",
        "x-xss-protection": "1"
      }

———————————————————————————————————————————-
#How to extract the list of all the catalogs of ALM using API #Retreive catalog ID of all the catalogs in ALM #JSON format #Catalog API #catalogs #state #status #names #catalog image #catalog details #catalog information #data #Adobe Learning Manager

0 Comments
Add Comment