Skip to content

Error at 'Query files/folders by metadata' #552

Description

@trysmr

Description of the issue

In the documentation for "Query files/folders by metadata", the POST method endpoint and the request example use different URLs.

This discrepancy may confuse developers. The POST method's URL is correct, I think.

Current content

The request example currently shows:

curl -i -X POST "https://api.box.com/2.0/files/12345" \
  -H "authorization: Bearer <ACCESS_TOKEN>" \
  -H "content-type: application/json" \
  -d '{
    "from": "enterprise_123456.contractTemplate",
    "query": "amount >= :value",
    "query_params": {
      "value": 100
    },
    "fields": [
      "name",
      "amount"
    ]
  }'

Expected content

The request example should use the correct endpoint:

curl -i -X POST "https://api.box.com/2.0/metadata_queries/execute_read" \
  -H "authorization: Bearer <ACCESS_TOKEN>" \
  -H "content-type: application/json" \
  -d '{
    "from": "enterprise_123456.contractTemplate",
    "query": "amount >= :value",
    "query_params": {
      "value": 100
    },
    "fields": [
      "name",
      "amount"
    ]
  }'

Link to the documentation page

https://developer.box.com/reference/post-metadata-queries-execute-read/

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationError found at Box Developer Documentation site

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions