Does "Find item for shared link" (shared_items) API endpoint officially support 'fields' param?

Answered

Follow

New post

becker2

• December 06, 2019 05:18

Hi,

 

We found that 'https://api.box.com/2.0/shared_items' (Find item for shared link) API endpoint supports 'fields' param in requests, but it is not documented here - https://developer.box.com/en/reference/get-shared-items/#request. It works in the same manner as 'fields' param for 'https://api.box.com/2.0/files/:file_id' (Get file information) endpoint.

 

Could we relay on this field in the production code?

0

• 

  jcleblanc

  • December 10, 2019 18:54

  Hi ,

   

  Yes, you can rely on fields being available for production code. I did a quick scan of the CLI and Node SDK to verify that fields was a viable option to supply through to the endpoint, and it is (see this Node SDK sample: https://github.com/box/box-node-sdk/blob/master/docs/shared-items.md). 

   

  With that said, this appears to be a discrepancy in the API endpoint documentation. I've filed a ticket so that we can update the API docs to add fields as a viable option.

   

  Thanks,

  Jon

  0

  Comment actions Permalink
• 

  jcleblanc

  • December 16, 2019 09:48

  Hi ,

   

  Just to follow up, fields is now listed in the docs: https://developer.box.com/en/reference/get-shared-items/.

   

  Thanks again,

  Jon

  0

  Comment actions Permalink

Please sign in to leave a comment.