Report Data

Describes the API specifications for retrieving report details.

Base URL:https://<SAP Fieldglass envionment URL>/api/vc

Methods

HTTP Method

Action

URL

GET

Get All Reports

/report

GET

Get Specified Report

/report/{report_id}

GET

Get Report with Filtering

/report/{report_id}/{filter1_name}=[filter1_value1]

Common Headers

Common Request Headers

Header

Required

Example Value

Data Type

Description

authorization

Yes

bearer [access token]

String

Security credentials for a login session.

Common Status and Error Codes

Code

Reason

Message

Description

200

Success response

OK

The request is valid and the response body has been created successfully. Refer to the specific method for details on a successful response body.

400

Error response

Bad request

The request is invalid. This response is returned if any of the following conditions are true:

  • The specified URL is invalid.

  • The request isn't formatted correctly.

  • The request is missing a required field.

401

Error response

Unauthorized

The email address and password used for authentication are wrong or expired.

403

Error response

Forbidden or insufficient authorization

Token isn't verified.

404

Error response

Not found

The service being requested doesn't exist.

429

Error response

Too many requests

The user has sent to many requests in a given amount of time.

500

Error response

Unexpected system error

The request is valid and the response body encountered a system error. Contact your system administrator.