Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-6185 Process Onboarding UX Prototype Iteration #1
  3. OPT-6254

Provide endpoint so that Web-Modeler can send user data for process owners

    • M

      Problem definition

      User Story

      As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition

      Solution Definition

      Optimize will provide a public API endpoint (POST) under /api/process/initialowner as specified below

      Optimize will save that information and associate it with the process definition as soon as the process definition data is imported

      Specification of the API-call:

      Http Method:

      POST

      Authorization:

      JWT Token from the current user session. Due to scope breakdown this will be handled with OPT-6280

      Endpoint: 

      /api/process/initial-owner

      Body: 

      {  "processDefinitionKey": "my_process_key",  "owner": "donald-duck"  }

      Response Code: 

      204 if transmission succesful

      401 if token is invalid

      403 if token is valid but not authorized to perform that operation

      500 if an internal error occurred

      Please note: There will be no validation on whether the processDefinitionKey and/or the provided owner is valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against

      Response Content:

      This method returns no content.

        This is the controller panel for Smart Panels app

            [OPT-6254] Provide endpoint so that Web-Modeler can send user data for process owners

            Giuliano Rodrigues Lima created issue -
            Giuliano Rodrigues Lima made changes -
            Status Original: Open [ 1 ] New: In Kickoff [ 11412 ]
            Giuliano Rodrigues Lima made changes -
            Status Original: In Kickoff [ 11412 ] New: In Development [ 10312 ]
            Giuliano Rodrigues Lima made changes -
            Link New: This issue is depended on by OPT-6189 [ OPT-6189 ]
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            {
             "processDefKey": "my_process_key",
             "owner": "donald-duck"
             }
            h4. Response Code: 

            204 if transmission succesful, 500 if an internal error occurred - There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            {
             "processDefKey": "my_process_key",
             "owner": "donald-duck"
             }
            h4. Response Code: 

            204 if transmission succesful, 500 if an internal error occurred - There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            { "processDefKey": "my_process_key", "owner": "donald-duck" }
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid or not authorized to perform that operation

            500 if an internal error occurred - There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            { "processDefKey": "my_process_key", "owner": "donald-duck" }
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid or not authorized to perform that operation

            500 if an internal error occurred - There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            { "processDefKey": "my_process_key", "owner": "donald-duck" }
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid or not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT generated by cloud console as described [here|https://docs.camunda.io/docs/self-managed/optimize-deployment/rest-api/authorization/]
            h4. Endpoint: 

            /api/public/metadata/collection
            h4. Body: 

            JSON format containing the keys "processDefKey" and "owner" (user ID of the owner), e.g.:

            { "processDefKey": "my_process_key", "owner": "donald-duck" }
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid or not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey and/or the user-id of the owner are valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT Token from the current user session. The user name will also be extracted from this token
            h4. Endpoint: 

            /api/process/\{processDefinitionKey}/initialowner
            h4. Body: 

            empty, no body necessary
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid

            403 if token is valid but not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/public/metadata/collection . The data for the process definition and the respective project owner can be provided in the body of the post request.

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT Token from the current user session. The user name will also be extracted from this token
            h4. Endpoint: 

            /api/process/\{processDefinitionKey}/initialowner
            h4. Body: 

            empty, no body necessary
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid

            403 if token is valid but not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/process/\{processDefinitionKey}/initialowner as specified below

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT Token from the current user session. The user name will also be extracted from this token
            h4. Endpoint: 

            /api/process/\{processDefinitionKey}/initialowner
            h4. Body: 

            empty, no body necessary
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid

            403 if token is valid but not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            Giuliano Rodrigues Lima made changes -
            Description Original: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/process/\{processDefinitionKey}/initialowner as specified below

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT Token from the current user session. The user name will also be extracted from this token
            h4. Endpoint: 

            /api/process/\{processDefinitionKey}/initialowner
            h4. Body: 

            empty, no body necessary
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid

            403 if token is valid but not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefKey, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.
            New: h1. Problem definition
            h2. User Story

            As a Product Manager, I want to be able to extract the information of who is the project owner for a given process definition
            h2. Solution Definition

            Optimize will provide a public API endpoint (POST) under /api/process/initialowner as specified below

            Optimize will save that information and associate it with the process definition as soon as the process definition data is imported
            h3. Specification of the API-call:
            h4. Http Method:

            POST
            h4. Authorization:

            JWT Token from the current user session. 
            h4. Endpoint: 

            /api/process/initialowner
            h4. Body: 

            {
             "processDefinitionKey": "my_process_key",
             "owner": "donald-duck"
             }
            h4. Response Code: 

            204 if transmission succesful

            401 if token is invalid

            403 if token is valid but not authorized to perform that operation

            500 if an internal error occurred

            Please note: There will be no validation on whether the processDefinitionKey and/or the provided owner is valid, since at the time of transmission it is not guaranteed that Optimize will have the data to proof against
            h4. Response Content:

            This method returns no content.

              Unassigned Unassigned
              giuliano.rodrigues-lima Giuliano Rodrigues Lima
              Giuliano Rodrigues Lima Giuliano Rodrigues Lima
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: