Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Content Import Job Management] Implement the Create Import Job REST endpoint #30669

Closed
6 tasks done
Tracked by #30550
valentinogiardino opened this issue Nov 15, 2024 · 6 comments · Fixed by #30698 or #30843
Closed
6 tasks done
Tracked by #30550

Comments

@valentinogiardino
Copy link
Contributor

valentinogiardino commented Nov 15, 2024

Parent Issue

#30550

Task

Implement the POST /content/import endpoint to allow the creation and enqueuing of new content import jobs. This endpoint will initiate the content import process and return a unique job identifier.

POST /content/import

Parameters:

  • Content Type: Specify the content type for the import (e.g., page, asset).
  • CSV File Reference: Reference to the CSV file containing the content to be imported.
  • Language Code(s): Define the language(s) for the imported content.
  • Workflow Action Id: Define the workflow action to apply to the imported content (e.g., publish, review).
  • Key Fields: Specify the fields used to match and update existing content (e.g., contentId, title).

Description:

This endpoint creates a new content import job, enqueues it into the job queue, and returns a unique job identifier. The content import will proceed based on the provided parameters and failure handling options.

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

Acceptance Criteria

  • The POST /content/import endpoint is implemented and returns a unique job identifier.
  • Basic validation is performed on input parameters (e.g., file type, content type).
  • Appropriate HTTP status codes are returned based on the request outcome.
  • Error messages are clear and actionable
  • The import job is successfully enqueued in the job queue system.
  • Postman tests are implemented

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

valentinogiardino added a commit that referenced this issue Nov 19, 2024
valentinogiardino added a commit that referenced this issue Nov 21, 2024
valentinogiardino added a commit that referenced this issue Nov 21, 2024
valentinogiardino added a commit that referenced this issue Nov 22, 2024
valentinogiardino added a commit that referenced this issue Nov 22, 2024
valentinogiardino added a commit that referenced this issue Nov 22, 2024
valentinogiardino added a commit that referenced this issue Nov 22, 2024
valentinogiardino added a commit that referenced this issue Nov 22, 2024
@fmontes
Copy link
Member

fmontes commented Dec 4, 2024

we need to be able to support field ids like this:

{
    "cmd":"preview",
    "contentType":"webPageContent",
    "workflowActionId":"b9d89c80-3d88-4311-8365-187323c96436",
    "language":"en-us",
    "fields":["418e887e2af64f780ea8e9e736533e22"]
}

we're only supporting variable names

{ "message": "Field [418e887e2af64f780ea8e9e736533e22] not found in Content Type [TestImportJob]." }

We need to create a ticket for this, is a blocker for the release to pass the field var.

@valentinogiardino
Copy link
Contributor Author

Rest API: Support field variable name as key field in Content Import Resource #30857

@nollymar nollymar closed this as completed Dec 5, 2024
@nollymar nollymar reopened this Dec 5, 2024
@github-project-automation github-project-automation bot moved this from QA - Backlog to Internal QA in dotCMS - Product Planning Dec 5, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning Dec 5, 2024
@nollymar nollymar closed this as completed Dec 5, 2024
@github-project-automation github-project-automation bot moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Dec 5, 2024
@nollymar nollymar moved this from Internal QA to New in dotCMS - Product Planning Dec 5, 2024
@nollymar nollymar moved this from New to QA - Backlog in dotCMS - Product Planning Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment