跳到主要内容

keepNewFileName

BooleanWrapper keepNewFileName(SettingsRequestDto)

PUT /api/2.0/files/keepnewfilename

Keep the default file name

Stores whether the caller wants new documents created with the default name instead of being asked for one, and returns the value that is now stored. It is a preference of the calling account: every authenticated role down to a guest may change its own copy, one member's choice never affects another, and an unauthenticated caller is refused. The portal only keeps the value and reports it - the creation operations, POST api/2.0/files/{folderId}/file among them, always use the title they are given, so this setting changes what an interface asks for rather than what the server does. Writing a value that is already stored is accepted and leaves the setting and the audit trail untouched. The value is published as keepNewFileName by GET api/2.0/files/settings, which is the only way to read it back. A new account starts with the prompt in place. The title a created document actually gets, and how a clash with an existing title is resolved, are decided by the creation request rather than here.

Parameters​

NameInTypeDescriptionNotes
SettingsRequestDtobodySettingsRequestDto[optional]

Responses​

Status codeDescriptionTypeResponse headers
200true if new documents are created with the default nameBooleanWrapperX-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset
401UnauthorizedErrorApiResponse-
429Too Many Requests.ErrorApiResponseRetry-After
500Internal Server Error.ErrorApiResponse-
400Bad Request.ErrorApiResponse-
502Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON.--
503Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON.--

Return type​

BooleanWrapper

Authorization​

Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json