AEM Links and Custom Scripts Additional APIs

swagger.yaml

@@ -12,6 +12,8 @@ tags:
     description: Data Merge API.
   - name: customScripts
     description: Custom Scripts API.
+  - name: remapLinks
+    description: Remap Links API.
 security:
   - ApiKeyAuth: []
   - BearerAuth: [] 
@@ -286,6 +288,146 @@ paths:
           $ref: "#/components/responses/NotFound"
         500:
           $ref: "#/components/responses/InternalServerError"
+    get:
+      tags:
+        - customScripts
+      summary: List all registered custom scripts.
+      description: Retrieves details of the latest version of all custom scripts registered by the customer. This includes version, script's download link, registration date, and script name. The response is paginated depending on list length.
+      parameters:
+        - name: x-gw-ims-org-id
+          in: header
+          description: Identifier for IMS organization as defined in Adobe's developer console
+          required: false
+          schema:
+            type: string
+        - name: x-api-key
+          in: header
+          description: API key as defined in Adobe's developer console
+          required: true
+          schema:
+            type: string
+        - name: Authorization
+          in: header
+          description: Authorization token with bearer "token_value"
+          required: true
+          schema:
+            type: string
+        - name: page
+          in: query
+          description: Page number for pagination
+          required: false
+          schema:
+            type: integer
+            default: 1
+      responses:
+        200:
+          description: List of registered custom scripts
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CustomScriptsListResponse'
+        400:
+          $ref: "#/components/responses/BadParams"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
+  /v3/scripts/{script_name}:
+    get:
+      tags:
+        - customScripts
+      summary: Get details of a specific custom script.
+      description: Retrieves details of a single custom script registered by the customer. This includes version, script's download link, registration date, and script name.
+      parameters:
+        - name: x-gw-ims-org-id
+          in: header
+          description: Identifier for IMS organization as defined in Adobe's developer console
+          required: false
+          schema:
+            type: string
+        - name: x-api-key
+          in: header
+          description: API key as defined in Adobe's developer console
+          required: true
+          schema:
+            type: string
+        - name: Authorization
+          in: header
+          description: Authorization token with bearer "token_value"
+          required: true
+          schema:
+            type: string
+        - name: script_name
+          in: path
+          description: Name of the custom script
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: Details of the custom script
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CustomScriptDetails'
+        400:
+          $ref: "#/components/responses/BadParams"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+    delete:
+      tags:
+        - customScripts
+      summary: Delete a specific custom script.
+      description: Deletes a single custom script registered by the customer. All versions of that script will be deleted.
+      parameters:
+        - name: x-gw-ims-org-id
+          in: header
+          description: Identifier for IMS organization as defined in Adobe's developer console
+          required: false
+          schema:
+            type: string
+        - name: x-api-key
+          in: header
+          description: API key as defined in Adobe's developer console
+          required: true
+          schema:
+            type: string
+        - name: Authorization
+          in: header
+          description: Authorization token with bearer "token_value"
+          required: true
+          schema:
+            type: string
+        - name: script_name
+          in: path
+          description: Name of the custom script to delete
+          required: true
+          schema:
+            type: string
+      responses:
+        204:
+          description: Script successfully deleted
+        400:
+          $ref: "#/components/responses/BadParams"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
 
   /v3/{script_id}/{script_name}:
     post:
@@ -345,6 +487,59 @@ paths:
         500:
           $ref: "#/components/responses/InternalServerError"
 
+  /v3/remap-links:
+    post:
+      tags:
+        - remapLinks
+      summary: Remaps file-based links to AEM URLs in InDesign documents
+      description: Replaces existing file-based links in InDesign documents with AEM URLs. This is particularly useful for customers working with AEM using AAL, as it allows designers to work with the output files post-generation by having direct links to AEM URLs.
+      operationId: remapLinks
+      parameters:
+        - name: x-gw-ims-org-id
+          in: header
+          description: Identifier for IMS organization as defined in Adobe's developer console. This is optional
+          required: false
+          schema:
+            type: string
+        - name: x-api-key
+          in: header
+          description: API key as defined in Adobe's developer console
+          required: true
+          schema:
+            type: string
+        - name: Authorization
+          in: header
+          description: Authorization token with bearer "token_value"
+          required: true
+          schema:
+            type: string
+        - name: x-aem-token
+          in: header
+          description: Bearer token generated for AEM technical account without the bearer keyword
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RemapLinksRequest"
+        description: Job request object that specifies parameters for remapping links in the InDesign document.
+        required: true
+      responses:
+        202:
+          $ref: '#/components/responses/Accepted'
+        400:
+          $ref: "#/components/responses/BadParams"
+        401:
+          $ref: "#/components/responses/Unauthorized"
+        403:
+          $ref: "#/components/responses/Forbidden"
+        404:
+          $ref: "#/components/responses/NotFound"
+        500:
+          $ref: "#/components/responses/InternalServerError"
+
 servers:
   - url: https://indesign.adobe.io/
 components:
@@ -1409,14 +1604,14 @@ components:
                 - succeeded
             data:
               type: object
-              description: Output response from  current state of the job.
+              description: Output response from current state of the job.
             dataURL:
               type: string
               description: The data returned from execution of the job. If the data is more than 250 kB and less the 20 MB, it will be provided as a presigned URL. If it is more than 20 MB, the job will fail.
             outputs:
               type: object
               description: This contains list of URL for all the generated assets 
-                  
+
     failedEvent:
       allOf:
         - $ref: '#/components/schemas/BaseEvent'
@@ -1433,8 +1628,10 @@ components:
               description: Error code for failure.
             message:
               type: string
-              description: Error message for failure 
-
+              description: Error message for failure
+            data:
+              type: object
+              description: Detailed error information
 
     ErrorCodesAndDefinitions:
       allOf:
@@ -1936,3 +2133,88 @@ components:
                 code:
                   type: integer
                   description: The error code.
+
+    RemapLinksRequest:
+      allOf:
+        - description: Inputs for the link remapping request.
+          type: object
+          required:
+            - params
+            - assets
+          properties:
+            assets:
+              type: array
+              items:
+                $ref: "#/components/schemas/InputAsset"
+            params:
+              type: object
+              required:
+                - targetDocument
+                - dataSource
+              properties:
+                targetDocument:
+                  description: The InDesign document in which links need to be remapped.
+                  type: string
+                dataSource:
+                  description: Array of link mappings containing source and destination URIs.
+                  type: array
+                  minItems: 1
+                  items:
+                    type: object
+                    required:
+                      - sourceURI
+                      - destinationURI
+                    properties:
+                      sourceURI:
+                        type: string
+                        description: File path/resource URI for the existing link that needs to be remapped.
+                      destinationURI:
+                        type: string
+                        description: AEM URI that will replace the existing link.
+            outputs:
+              type: array
+              items:
+                $ref: '#/components/schemas/OutputAsset'
+
+    CustomScriptsListResponse:
+      type: object
+      description: Response containing list of registered custom scripts
+      properties:
+        capabilities:
+          type: array
+          items:
+            $ref: '#/components/schemas/CustomScriptDetails'
+        paging:
+          type: object
+          properties:
+            nextUrl:
+              type: string
+              description: URL for the next page of results
+              example: "https://indesign.adobe.io/api/v3/scripts?page=2"
+
+    CustomScriptDetails:
+      type: object
+      description: Details of a custom script
+      properties:
+        version:
+          type: string
+          description: Version of the custom script
+          example: "1.0.2"
+        url:
+          type: string
+          description: URL that was generated during registration
+          example: "https://indesign.adobe.io/v3/634aaf2dd50c8d198/idml/export"
+        downloadurl:
+          type: string
+          description: Pre-signed URL for downloading the script (valid for 30 minutes)
+          example: "https://example.com/download/script.zip"
+        createdDate:
+          type: string
+          format: date-time
+          description: Registration date of the script
+          example: "2025-07-03T08:44:26.051Z"
+        scriptName:
+          type: string
+          description: Name of the custom script
+          example: "3p-testing/test1"
+