cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
oguruma
Helper III
Helper III

Custom Connector: Array for query parameter?

I'm building a Custom Connector for ERPNext. It uses the Filter Parameter to filter for criteria.

 

The Parameter accepts an array of arrays. For example 

 

https://erp.com/api/resource/Lead/?fields=["name"]&filters=[["company_name","=","Microsoft"],["rating",">","1"]]

 

would filter for Leads with the company name "Microsoft," and a Rating greater than 1, and retrieve the "Name" field.

 

The problem is that when I try to describe this in the Custom Connector Wizard, I get the error message 

 

Your custom connector has been successfully updated, but there was an issue converting it to WADL for Power Apps: An error occured while converting OpenAPI file to WADL file. Error: 'Parameter with type='array' is not currently supported at JSON path paths['/api/resource/Lead/'].get.parameters[0]'

 

 

My Swagger is 

 

swagger: '2.0'
info: {title: ERPNext, description: '', version: '1.0'}
host: erp.com
basePath: /
schemes: [https]
consumes: []
produces: []
paths:
  /api/resource/Lead/:
    get:
      responses:
        default:
          description: default
          schema: {}
      summary: Filter Leads By Company Name
      operationId: LeadsByCompanyName
      parameters:
      - {name: fields, in: query, required: false, type: array}
      - {name: filters, in: query, required: false, type: array}
definitions: {}
parameters: {}
responses: {}
securityDefinitions:
  basic_auth: {type: basic}
security:
- basic_auth: []
tags: []

 

In Swagger, for the Parameters, I get the message "Schemas with type Array require sibling "Item" fields. 

6 REPLIES 6
HS_Nico
Helper II
Helper II

Hi @oguruma ,

 

try to use the official OpenAPI definition of ERPNext (ERPNext | 13 | alyf.de | SwaggerHub) in your connector. This has always worked well for me so far. Unfortunately I can't test it for your API because I don't have access to ERPNext.

 

Usually you can also create a connector directly from the definition (https://api.swaggerhub.com/apis/alyf.de/ERPNext/13), but unfortunately OpenAPI version 3 is still not supported.

 

I saw that version 14 of ERPNext already exists, unfortunately I could only find the OpenAPI definition in version 13.

Thanks for the input. I used an online tool to convert the V3 to V2 Swagger. I do get the error message below when I try to save the connector based on that definition. 

Specified swagger has the following errors: 'Definition is not valid. Error: 'Error : paths/~1method~1logout/get/responses/200/schema/default : The 'default' value is of type 'String', but should match the given type 'Object'. ## Error : paths/~1resource~1{DocType}/get/parameters/1/default : The 'default' value is of type 'String', but should match the given type 'Array'. '

 

swagger: '2.0'
info:
  version: '0.0.1'
  title: Frappe / ERPNext API
  description: >
    Unofficial documentation of the [Frappe](https://frappe.io) / [ERPNext](https://erpnext.org) API.
  contact:
    email: raffael@alyf.de
    name: Raffael Meyer
    url: https://alyf.de
host: demo.erpnext.com
basePath: /api
securityDefinitions:
  tokenAuth:
    type: apiKey
    description: >-
      Get your API keys at User -> Api Access -> Generate Keys.

      "headers = {'Authorization': 'token <api_key>:<api_secret>'}"
    name: Authorization
    in: header
  basicAuth:
    type: basic
    description: >
      Get your API keys at User -> Api Access -> Generate Keys.

      username = api_key; password = api_secret

      [More info](https://frappe.io/docs/user/en/guides/integration/token_based_auth)
  oAuth2:
    type: oauth2
    description: "This API uses OAuth 2 with the authorization code flow. \n[More info]https://frappe.io/docs/user/en/guides/integration/using_oauth)\n"
    flow: accessCode
    authorizationUrl: https://demo.erpnext.com/api/method/frappe.integrations.oauth2.authorize
    tokenUrl: https://demo.erpnext.com/api/method/frappe.integrations.oauth2.get_token
    scopes:
      all: Same permissions as the user who created the oAuth client
schemes:
- https
consumes:
- application/json
produces:
- application/json
paths:
  /method/login:
    post:
      description: Authenticate yourself
      summary: login
      tags:
      - Naive Authentication
      operationId: login
      deprecated: false
      produces:
      - application/json
      - text/html
      consumes:
      - application/x-www-form-urlencoded
      parameters:
      - name: usr
        in: query
        required: false
        type: string
        description: Your username
      - name: pwd
        in: query
        required: false
        type: string
        description: Your password
      - name: Content-Type
        in: header
        required: false
        enum:
        - application/x-www-form-urlencoded
        type: string
        description: ''
      - name: data
        in: formData
        required: false
        type: string
        description: ''
      responses:
        '200':
          description: Login successful
          schema:
            $ref: '#/definitions/MethodLoginResponse'
          headers: {}
        '401':
          description: oneOf(Incomplete login details, Incorrect password, User disabled or missing)
          schema:
            $ref: '#/definitions/MethodLogin401Error1'
          headers: {}
  /method/logout:
    get:
      description: Logout from current session
      summary: Logout from current session
      tags:
      - Naive Authentication
      operationId: Logoutfromcurrentsession
      deprecated: false
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Logged out.
          schema:
            type: object
            default: ''
          headers: {}
  /method/frappe.auth.get_logged_user:
    get:
      description: Get the currently logged in user
      summary: authGetLoggedUser
      tags:
      - Naive Authentication
      operationId: authGetLoggedUser
      deprecated: false
      produces:
      - application/json
      - text/html
      parameters: []
      responses:
        '200':
          description: search results matching criteria
          schema:
            $ref: '#/definitions/MethodFrappeAuthGetLoggedUserResponse'
          headers: {}
        '401':
          description: Not permitted
          schema:
            $ref: '#/definitions/MethodFrappeAuthGetLoggedUser401Error1'
          headers: {}
  /method/version:
    get:
      description: Get the version of the app
      summary: Get the version of the app
      operationId: Gettheversionoftheapp
      deprecated: false
      produces:
      - application/json
      parameters: []
      responses:
        '200':
          description: Successful
          schema:
            $ref: '#/definitions/MethodVersionResponse'
          headers: {}
  /resource/{DocType}:
    post:
      description: Create a new document
      summary: Create a new document
      operationId: Createanewdocument
      deprecated: false
      produces:
      - application/json
      - text/html
      consumes:
      - application/x-www-form-urlencoded
      parameters:
      - name: DocType
        in: path
        required: true
        type: string
        description: The DocType you'd like to receive. For example, Customer.
      - name: Content-Type
        in: header
        required: false
        enum:
        - application/x-www-form-urlencoded
        type: string
        description: ''
      - name: data
        in: formData
        required: false
        type: string
        description: ''
      responses:
        '200':
          description: Document created
          schema:
            $ref: '#/definitions/ResourceResponse'
          headers: {}
        '403':
          description: Insufficient Permission
          schema:
            $ref: '#/definitions/Resource403Error1'
          headers: {}
    get:
      description: Returns a list of documents of the given type
      summary: Get a list of documents
      operationId: Getalistofdocuments
      deprecated: false
      produces:
      - application/json
      parameters:
      - name: DocType
        in: path
        required: true
        type: string
        description: "The DocType you'd like to receive. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc."
      - name: fields
        in: query
        required: false
        default: >-
          [

            "name"

          ]
        type: array
        items:
          type: string
        description: "By default, only the \"name\" field is included in the listing, to add more fields, \nyou can pass the fields param to GET request. For example, fields=[\"name\",\"country\"]"
      - name: filters
        in: query
        required: false
        type: array
        items:
          type: array
          items:
            type: string
        description: >-
          You can filter the listing using sql conditions by passing them as the filters GET param.

          Each condition is an array of the format, [{doctype}, {field}, {operator}, {value}].

          For example, filters=[["Customer", "country", "=", "India"]]
      - name: limit_page_length
        in: query
        required: false
        default: 20
        type: integer
        format: int32
        description: "By default, all listings are returned paginated. With this parameter you can change the \npage size (how many items are teturned at once)."
      - name: limit_start
        in: query
        required: false
        default: 0
        type: integer
        format: int32
        description: "To request successive pages, pass a multiple of your limit_page_length as limit_start. \nFor Example, to request the second page, pass limit_start as 20."
      responses:
        '200':
          description: "Found requested DocType. By default, only the \"name\" field is included in the listing, \nto add more fields, you can pass the fields param to GET request."
          schema:
            $ref: '#/definitions/DocList'
          headers: {}
  /resource/{DocType}/{DocumentName}:
    get:
      description: Get a document by it's name, for example EMP001 of DocType Employee.
      summary: Get a specific document
      operationId: Getaspecificdocument
      deprecated: false
      produces:
      - application/json
      parameters:
      - name: DocType
        in: path
        required: true
        type: string
        description: "The DocType you'd like to receive. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc."
      - name: DocumentName
        in: path
        required: true
        type: string
        description: The name (ID) of the document you'd like to receive. For example EMP001 (of type Employee).
      responses:
        '200':
          description: Found requested document
          schema:
            $ref: '#/definitions/ResourceResponse'
          headers: {}
    put:
      description: TBD
      summary: Update a specific document
      operationId: Updateaspecificdocument
      deprecated: false
      produces:
      - application/json
      parameters:
      - name: DocType
        in: path
        required: true
        type: string
        description: "The DocType you'd like to update. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc."
      - name: DocumentName
        in: path
        required: true
        type: string
        description: The name (ID) of the document you'd like to update. For example EMP001 (of type Employee).
      responses:
        '200':
          description: Updated specified document
          schema:
            $ref: '#/definitions/ResourceResponse'
          headers: {}
    delete:
      description: TBD
      summary: Delete a specific document
      operationId: Deleteaspecificdocument
      deprecated: false
      produces:
      - application/json
      parameters:
      - name: DocType
        in: path
        required: true
        type: string
        description: "The type of the document you'd like to delete. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc."
      - name: DocumentName
        in: path
        required: true
        type: string
        description: The name (ID) of the document you'd like to delete. For example EMP001 (of type Employee).
      responses:
        '202':
          description: Deleted specified document
          schema:
            $ref: '#/definitions/ResourceResponse3'
          headers: {}
definitions:
  DocType:
    title: DocType
    type: object
    properties:
      name:
        type: string
      modified_by:
        type: string
      creation:
        type: string
      modified:
        type: string
      doctype:
        type: string
      owner:
        type: string
      docstatus:
        type: integer
        format: int32
  DocList:
    title: DocList
    type: object
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/DocType'
  MethodFrappeAuthGetLoggedUser401Error1:
    title: MethodFrappeAuthGetLoggedUser401Error1
    type: object
    properties:
      exc:
        example: Traceback (most recent call last) ...
        type: string
      _server_messages:
        example:
        - message: Not permitted
        type: string
  MethodFrappeAuthGetLoggedUserResponse:
    title: MethodFrappeAuthGetLoggedUserResponse
    type: object
    properties:
      message:
        example: demo@erpnext.com
        type: string
  MethodLogin401Error1:
    title: MethodLogin401Error1
    type: object
    properties:
      exc:
        example: Traceback (most recent call last) ...
        type: string
      message:
        example: Incorrect password
        type: string
  MethodLoginResponse:
    title: MethodLoginResponse
    type: object
    properties:
      full_name:
        example: Administrator
        type: string
      message:
        example: Logged in
        type: string
      home_page:
        example: /desk
        type: string
  MethodVersionResponse:
    title: MethodVersionResponse
    type: object
    properties:
      message:
        example: 10.1.36
        type: string
  Resource403Error1:
    title: Resource403Error1
    type: object
    properties:
      exc:
        example: Traceback (most recent call last) ...
        type: string
      _error_message:
        example: Insufficient Permission for {DocType}
        type: string
  ResourceResponse:
    title: ResourceResponse
    type: object
    properties:
      data:
        $ref: '#/definitions/DocType'
  ResourceResponse3:
    title: ResourceResponse3
    type: object
    properties:
      message:
        type: string
security: []
tags:
- name: Naive Authentication
  description: If you are developing something serious, you may want to use oAuth2.
HS_Nico
Helper II
Helper II

To fix the error you need to append "items: {type: string}" to your parameter definition. You do that in Swagger Editor. Your code should then look like this:

parameters:
- {name: fields, in: query, required: false, type: array, items: {type: string}}
- {name: filters, in: query, required: false, type: array, items: {type: string}}

I believe I found the offending part in Swagger.

 

        default: "[\n\n  \"name\"\n\n]"

 

When I delete that line, the error message goes away. The default value is an array with "name" in it, but swagger is evaluating "[\n\n \"name\"\n\n]" as a string, instead of as an array. What's the proper way to denote a literal array for a default value?

 

Even after deleting the offending line, and getting rid of the error message, I can save the Connector, but I still receive the message 

Your custom connector has been successfully updated, but there was an issue converting it to WADL for Power Apps: An error occured while converting OpenAPI file to WADL file. Error: 'Parameter with type='array' is not currently supported at JSON path paths['/resource/{DocType}'].get.parameters[1]'

 

HS_Nico
Helper II
Helper II

Ignore my suggestion with the official OpenAPI documentation and build your connector manually. Then you will again face the problem of your introductory question ("Schemas with type Array require sibling "Item"), which you can fix with my second answer.

HS_Nico
Helper II
Helper II

Has your problem now been resolved? If my answer helped you, I would be happy if you would accept it as a solution.

Helpful resources

Announcements

Exclusive LIVE Community Event: Power Apps Copilot Coffee Chat with Copilot Studio Product Team

  It's time for the SECOND Power Apps Copilot Coffee Chat featuring the Copilot Studio product team, which will be held LIVE on April 3, 2024 at 9:30 AM Pacific Daylight Time (PDT).     This is an incredible opportunity to connect with members of the Copilot Studio product team and ask them anything about Copilot Studio. We'll share our special guests with you shortly--but we want to encourage to mark your calendars now because you will not want to miss the conversation.   This live event will give you the unique opportunity to learn more about Copilot Studio plans, where we’ll focus, and get insight into upcoming features. We’re looking forward to hearing from the community, so bring your questions!   TO GET ACCESS TO THIS EXCLUSIVE AMA: Kudo this post to reserve your spot! Reserve your spot now by kudoing this post.  Reservations will be prioritized on when your kudo for the post comes through, so don't wait! Click that "kudo button" today.   Invitations will be sent on April 2nd.Users posting Kudos after April 2nd. at 9AM PDT may not receive an invitation but will be able to view the session online after conclusion of the event. Give your "kudo" today and mark your calendars for April 3rd, 2024 at 9:30 AM PDT and join us for an engaging and informative session!

Tuesday Tip: Unlocking Community Achievements and Earning Badges

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!     THIS WEEK'S TIP: Unlocking Achievements and Earning BadgesAcross the Communities, you'll see badges on users profile that recognize and reward their engagement and contributions. These badges each signify a different achievement--and all of those achievements are available to any Community member! If you're a seasoned pro or just getting started, you too can earn badges for the great work you do. Check out some details on Community badges below--and find out more in the detailed link at the end of the article!       A Diverse Range of Badges to Collect The badges you can earn in the Community cover a wide array of activities, including: Kudos Received: Acknowledges the number of times a user’s post has been appreciated with a “Kudo.”Kudos Given: Highlights the user’s generosity in recognizing others’ contributions.Topics Created: Tracks the number of discussions initiated by a user.Solutions Provided: Celebrates the instances where a user’s response is marked as the correct solution.Reply: Counts the number of times a user has engaged with community discussions.Blog Contributor: Honors those who contribute valuable content and are invited to write for the community blog.       A Community Evolving Together Badges are not only a great way to recognize outstanding contributions of our amazing Community members--they are also a way to continue fostering a collaborative and supportive environment. As you continue to share your knowledge and assist each other these badges serve as a visual representation of your valuable contributions.   Find out more about badges in these Community Support pages in each Community: All About Community Badges - Power Apps CommunityAll About Community Badges - Power Automate CommunityAll About Community Badges - Copilot Studio CommunityAll About Community Badges - Power Pages Community

Tuesday Tips: Powering Up Your Community Profile

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   This Week's Tip: Power Up Your Profile!  🚀 It's where every Community member gets their start, and it's essential that you keep it updated! Your Community User Profile is how you're able to get messages, post solutions, ask questions--and as you rank up, it's where your badges will appear and how you'll be known when you start blogging in the Community Blog. Your Community User Profile is how the Community knows you--so it's essential that it works the way you need it to! From changing your username to updating contact information, this Knowledge Base Article is your best resource for powering up your profile.     Password Puzzles? No Problem! Find out how to sync your Azure AD password with your community account, ensuring a seamless sign-in. No separate passwords to remember! Job Jumps & Email Swaps Changed jobs? Got a new email? Fear not! You'll find out how to link your shiny new email to your existing community account, keeping your contributions and connections intact. Username Uncertainties Unraveled Picking the perfect username is crucial--and sometimes the original choice you signed up with doesn't fit as well as you may have thought. There's a quick way to request an update here--but remember, your username is your community identity, so choose wisely. "Need Admin Approval" Warning Window? If you see this error message while using the community, don't worry. A simple process will help you get where you need to go. If you still need assistance, find out how to contact your Community Support team. Whatever you're looking for, when it comes to your profile, the Community Account Support Knowledge Base article is your treasure trove of tips as you navigate the nuances of your Community Profile. It’s the ultimate resource for keeping your digital identity in tip-top shape while engaging with the Power Platform Community. So, dive in and power up your profile today!  💪🚀   Community Account Support | Power Apps Community Account Support | Power AutomateCommunity Account Support | Copilot Studio  Community Account Support | Power Pages

Super User of the Month | Chris Piasecki

In our 2nd installment of this new ongoing feature in the Community, we're thrilled to announce that Chris Piasecki is our Super User of the Month for March 2024. If you've been in the Community for a while, we're sure you've seen a comment or marked one of Chris' helpful tips as a solution--he's been a Super User for SEVEN consecutive seasons!       Since authoring his first reply in April 2020 to his most recent achievement organizing the Canadian Power Platform Summit this month, Chris has helped countless Community members with his insights and expertise. In addition to being a Super User, Chris is also a User Group leader, Microsoft MVP, and a featured speaker at the Microsoft Power Platform Conference. His contributions to the new SUIT program, along with his joyous personality and willingness to jump in and help so many members has made Chris a fixture in the Power Platform Community.   When Chris isn't authoring solutions or organizing events, he's actively leading Piasecki Consulting, specializing in solution architecture, integration, DevOps, and more--helping clients discover how to strategize and implement Microsoft's technology platforms. We are grateful for Chris' insightful help in the Community and look forward to even more amazing milestones as he continues to assist so many with his great tips, solutions--always with a smile and a great sense of humor.You can find Chris in the Community and on LinkedIn. Thanks for being such a SUPER user, Chris! 💪🌠

Tuesday Tips: Community Ranks and YOU

TUESDAY TIPS are our way of communicating helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! We cover basics about the Community, provide a few "insider tips" to make your experience even better, and share best practices gleaned from our most active community members and Super Users.   With so many new Community members joining us each week, we'll also review a few of our "best practices" so you know just "how" the Community works, so make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!This Week: Community Ranks--Moving from "Member" to "Community Champion"   Have you ever wondered how your fellow community members ascend the ranks within our community? What sets apart an Advocate from a Helper, or a Solution Sage from a Community Champion? In today’s #TuesdayTip, we’re unveiling the secrets and sharing tips to help YOU elevate your ranking—and why it matters to our vibrant communities. Community ranks serve as a window into a member’s role and activity. They celebrate your accomplishments and reveal whether someone has been actively contributing and assisting others. For instance, a Super User is someone who has been exceptionally helpful and engaged. Some ranks even come with special permissions, especially those related to community management. As you actively participate—whether by creating new topics, providing solutions, or earning kudos—your rank can climb. Each time you achieve a new rank, you’ll receive an email notification. Look out for the icon and rank name displayed next to your username—it’s a badge of honor! Fun fact: Your Community Engagement Team keeps an eye on these ranks, recognizing the most passionate and active community members. So shine brightly with valuable content, and you might just earn well-deserved recognition! Where can you see someone’s rank? When viewing a post, you’ll find a member’s rank to the left of their name.Click on a username to explore their profile, where their rank is prominently displayed. What about the ranks themselves? New members start as New Members, progressing to Regular Visitors, and then Frequent Visitors.Beyond that, we have a categorized system: Kudo Ranks: Earned through kudos (teal icons).Post Ranks: Based on your posts (purple icons).Solution Ranks: Reflecting your solutions (green icons).Combo Ranks: These orange icons combine kudos, solutions, and posts. The top ranks have unique names, making your journey even more exciting! So dive in, collect those kudos, share solutions, and let’s see how high you can rank! 🌟 🚀   Check out the Using the Community boards in each of the communities for more helpful information!  Power Apps, Power Automate, Copilot Studio & Power Pages

Find Out What Makes Super Users So Super

We know many of you visit the Power Platform Communities to ask questions and receive answers. But do you know that many of our best answers and solutions come from Community members who are super active, helping anyone who needs a little help getting unstuck with Business Applications products? We call these dedicated Community members Super Users because they are the real heroes in the Community, willing to jump in whenever they can to help! Maybe you've encountered them yourself and they've solved some of your biggest questions. Have you ever wondered, "Why?"We interviewed several of our Super Users to understand what drives them to help in the Community--and discover the difference it has made in their lives as well! Take a look in our gallery today: What Motivates a Super User? - Power Platform Community (microsoft.com)

Users online (6,544)