Uploaded image for project: 'Jira Service Management Cloud'
  1. Jira Service Management Cloud
  2. JSDCLOUD-11886

Improve the external import developer documentation

    XMLWordPrintable

Details

    • 8
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

    Description

      I may be in minority here - I find that the external import developer documentation (located https://developer.atlassian.com/cloud/insight/rest/api-group-import/#api-import-start-id-post, https://developer.atlassian.com/cloud/insight/imports/introduction/ and https://developer.atlassian.com/cloud/insight/imports/workflow/ and https://developer.atlassian.com/cloud/insight/imports/schema-and-mapping/) seems to be lacking clarity on various subjects. The docs are definitely helpful and I believe can be improved upon.

      Here are some examples:

      • What should the schema/mapping payload JSON include when only pushing object data where changes to the object types/attributes are not required. It took me several hours of trying different payloads to figure out that I only needed to include the objectType without any attributes (in retrospect this seems evident - for whatever reason it didn't click in my head).
      • The PUT call described is only for the initial creation of the object types and attributes and PATCH needs to be used going forward with regular updates.
      • The REST API document only describes two (the POST to start the mapping and the GET for progress) of the eight APIs. The following APIs aren't covered:
      • What is and isn't supported in the API versus the UI. For example, configuring any of the attribute's properties (Include children, Unique, Cardinality, or Filter objects) through the import API is not supported. I realized this because I've messed with the UI enough to understand the gaps, it would be helpful though to call these out in documentation instead of leaving the reader to figure this out because they aren't defined.

       

      Attachments

        Activity

          People

            a87d370e2131 Jeffery Shaughnessy
            3f7da8170c58 R. Boswell
            Votes:
            13 Vote for this issue
            Watchers:
            7 Start watching this issue

            Dates

              Created:
              Updated: