Question
Aaseya IT services
IN
Last activity: 16 May 2017 16:36 EDT
Need help to build a data structure for Connect-Rest service; mapping "type" : "file"
Hi All,
I need to build a data structure for the Connect-Rest service.please find the details about the method below.
I have a problem for mapping "type" : "file" .what is the equivalent mapping for file type in pega.
"post" : {
"tags" : [ "Documents" ],
"description" : "Creates a document and returns its identifier",
"operationId" : "createDocument",
"consumes" : [ "multipart/form-data" ],
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "name",
"in" : "formData",
"description" : "Document name",
"required" : true,
"type" : "string"
}, {
"name" : "title",
"in" : "formData",
"description" : "Document title",
"required" : false,
"type" : "string"
}, {
"name" : "subject",
"in" : "formData",
"description" : "Document subject",
"required" : false,
"type" : "string"
}, {
"name" : "author",
"in" : "formData",
"description" : "Document author",
"required" : false,
"type" : "string"
}, {
"name" : "tags",
"in" : "formData",
"description" : "Document tags",
Hi All,
I need to build a data structure for the Connect-Rest service.please find the details about the method below.
I have a problem for mapping "type" : "file" .what is the equivalent mapping for file type in pega.
"post" : {
"tags" : [ "Documents" ],
"description" : "Creates a document and returns its identifier",
"operationId" : "createDocument",
"consumes" : [ "multipart/form-data" ],
"produces" : [ "text/plain" ],
"parameters" : [ {
"name" : "name",
"in" : "formData",
"description" : "Document name",
"required" : true,
"type" : "string"
}, {
"name" : "title",
"in" : "formData",
"description" : "Document title",
"required" : false,
"type" : "string"
}, {
"name" : "subject",
"in" : "formData",
"description" : "Document subject",
"required" : false,
"type" : "string"
}, {
"name" : "author",
"in" : "formData",
"description" : "Document author",
"required" : false,
"type" : "string"
}, {
"name" : "tags",
"in" : "formData",
"description" : "Document tags",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "extendedProperties",
"in" : "formData",
"description" : "Document extended properties",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
"collectionFormat" : "multi"
}, {
"name" : "content",
"in" : "formData",
"description" : "Document content",
"required" : false,
"type" : "file"
} ],
"responses" : {
"200" : {
"description" : "Document identifier",
"schema" : {
"type" : "string"
}
},
"400" : {
"description" : "`Bad Request`: One or more parameters are missing or unknown"
},
"401" : {
"description" : "`Unauthorized`: Authentication header not provided or session expired"
},
"403" : {
"description" : "`Forbidden`: You are not authorized to use this application"
},
"429" : {
"description" : "`Too many requests`: The client is sending too many requests with failure"
},
"500" : {
"description" : "Internal API error / Server error"
}
},
}
Please help me.
Message was edited by: Lochana DurgadaVijayakumar
Pegasystems Inc.
CA
The equivalent for "file" type, in this context, would be a request attachment populated on a named page called pyRequestAttachmentPage. You don't have to create a Pega property for this. This looks like swagger schema. Your service seems to expect a multipart/form-data request (POST). One part is of content-type application/x-www-form-urlencoded with different form data params such as name, title, subject, author, etc. and another part containing the actual document content.
Aaseya IT services
IN
HI Praneeth,
Thanks for the quick help.I have one more doubt . Can you please clarify it.
in the above request we have a snippet
"collectionFormat" : "multi"
}, {
"name" : "extendedProperties",
"in" : "formData",
"description" : "Document extended properties",
"required" : false,
"type" : "array",
"items" : {
"type" : "string"
},
for this do i need to create a Pagelist with the name extendedProperties as the type is mentioned as array. what the "items" tag represent here as it doesn't have any property names it has only type. Can you help me how to map this request snippet.
Thanks,
Saleem
Pegasystems Inc.
CA
This is tricky. I think extendedProperties needs to be a value list as the schema seems to indicate it's an array of strings and not complex objects. But we have been trying to get away from using value list properties in the integration layer. So you could try with a "special" type of page list property, i.e., create a page list property called extendedProperties but have the page class as SingleValue-Text. I suggest you check the runtime behavior with both page list and value list properties.
Virtusa
IN
Hi Praneeth,
We have the same scenario in our application. We have to pass a file to Connect-REST rule. We followed the steps to populate pyRequestAttachmentPage page. But the json req created doesnt show the file attachments and we are getting 400 error (file is a required param).
Could you pls check the attached docs and guide us in resolving the issue.
Thanks.