URL structure

1 https://access-service.xy-company.com/api/v1/config/theme/webappHelpUrl

Supported methods and overview

PUT - sets (or clears) the Web Application Help URL property (accessible through the System Details section of the Configuration page of SafeShare Administration).

Detailed description

This API endpoint sets (or clears) the Web Application Help URL property (accessible through the System Details section of the Configuration page of SafeShare Administration).

The current value of this property can be obtained using the <access-service>/theme... API endpoint.

Note: This property can be overridden at the organisation level using the <access-service>/api/v1/organisations/{orgGroupId} API endpoint.

Supported roles

This API endpoint supports the following Cocoon Data user roles (as described in the SafeShare Administrator's Guide):

SafeShare administrator

The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

The following header is required if the body of the request has a JSON object:

Content-Type: application/json

Required body

Specify the Web Application Help URL property value (i.e. the full URL for this property) in the body of the request as plain text.

To clear this property's value, specify an empty JSON object in the body of the request:

{}

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.