DataOneDave
Design Dabbler

Octet-Stream File Upload in Nintex Xtensions

I want to integreate a service to my Workflow Cloud with a file upload. 

 

I have defined the parameters according to the documentation.

 

Like this:

 

 "parameters": [
          
          {
            "name""modelId",
            "in""path",
            "description""Format - uuid. Model identifier.",
            "required"true,
            "type""string"
          },
          {
            "name""includeTextDetails",
            "in""query",
            "description""Include text lines and element references in the result.  Default: false.",
            "type""boolean"
          },
          {
            "name": "source",
            "in": "body",
            "required": true,
            "schema": {
            "type": "string",
            "format": "binary"
            }
          }
        ],
 
But my action expects a string, not a file upload. (See attached image)
Is that a bug?
Or what must the input look like?
Or is there something wrong in my definition?
 
The other file upload types do not seem to be supported by the service, so i want to try this one.
 
Thanks in advance and best regards
Dave
0 Kudos
Reply
7 Replies
butlerj
Community Manager Community Manager
Community Manager

Re: Octet-Stream File Upload in Nintex Xtensions

@DataOneDave I think this issue might be the OpenAPI version that you're working with. NWC currently supports OpenAPI 2 (though work is being done to support OpenAPI 3), so it looks like you would want to use a slightly different format: https://swagger.io/docs/specification/2-0/file-upload/

 

Hope that helps!

Reply
DataOneDave
Design Dabbler

Re: Octet-Stream File Upload in Nintex Xtensions

@butlerj

Thanks for the quick reply



you mean octet-stream is not supported by Swagger 2.0 ?

I followed this documentation, so it should work, right?



https://help.nintex.com/en-US/xtensions/04_Reference/REF_OpenAPISwipeFile.htm#File_handling



I have already tried it with multipart/form-data. Unfortunately the service does not accept this type.

0 Kudos
Reply
butlerj
Community Manager Community Manager
Community Manager

Re: Octet-Stream File Upload in Nintex Xtensions

@DataOneDave interesting. I'll need to circle with one of my devs to check that out, as I was under the impression that we didn't support octet-stream due to the Swagger version, but the fact that it's in the help files is making me question my sanity a little :?

 

Will let you know as soon as I have a confirmation one way or the other. 

Reply
DataOneDave
Design Dabbler

Re: Octet-Stream File Upload in Nintex Xtensions

haha ok. 🙂 Thank you very much @butlerj
would be great if we could solve this. 🙂
0 Kudos
Reply
DataOneDave
Design Dabbler

Re: Octet-Stream File Upload in Nintex Xtensions

@butlerj is there a solution in the meantime?  😇
Or is the information in the documentation wrong?

0 Kudos
Reply
butlerj
Community Manager Community Manager
Community Manager

Re: Octet-Stream File Upload in Nintex Xtensions

Hi @DataOneDave sorry I completely lost track of this post. I'm not sure if there is a workaround, but let me circle with the team again and see what I can find. I've made myself an action item so I don't lose it this time :?

0 Kudos
Reply
butlerj
Community Manager Community Manager
Community Manager

Re: Octet-Stream File Upload in Nintex Xtensions

@DataOneDave just to confirm you're entire structure looks like this correct:

 

{
    "upload": {
        "summary": "Analyze Form",
        "description": "Upload form",
        "operationId": "UploadForm",
        "consumes": [ "application/octet-stream" ],
        "parameters": [
        {
            "name": "modelId",
            "in": "path",
            "description": "Format - uuid. Model identifier.",
            "required": true,
            "type": "string"
            },
            {
            "name": "includeTextDetails",
            "in": "query",
            "description": "Include text lines and element references in the result.  Default: false.",
            "type": "boolean"
            },
            {
            "name": "source",
            "in": "body",
            "required": true,
            "schema": 
            {
                "type": "string",
                "format": "binary"
            }
        }
    ]
}
0 Kudos
Reply