Сменить директорию

Rename directory or modify its attributes. When renaming directory the path can not be changed (it means new_name parameter can not contain path, name only).

Запрос

POST https://api.crowdin.com/api/project/{идентификатор-проекта}/change-directory?key={ключ-проекта}

Параметры

Название Значение Описание
name обязательный строка Full directory path that should be modified (e.g. /MainPage/AboutUs).
new_name optional строка New directory name.
title необязательный строка New directory title to be displayed in Crowdin UI.
export_pattern необязательный строка New directory export pattern. Is used to create directory name and path in resulted translations bundle.
branch необязательный строка The name of related version branch (Versions Management).
json необязательный строка Может не содержать значение. Указывает, что ответ должен быть в формате JSON.
jsonp необязательный строка Callback function name. Defines that response should be in JSONP format.
Переменные
project-identifier обязательный строка Должен содержать идентификатор проекта.
project-key обязательный строка API-ключ проекта.

Ответ

If successful, this method returns a XML structure, as it is shown below. 
<?xml version="1.0" encoding="ISO-8859-1"?>
<success>
</success>
Образец ответа при неудавшемся запросе: 
<?xml version="1.0" encoding="ISO-8859-1"?>
<error>
  <code>3</code>
  <message>API key is not valid</message>
</error>

Примеры

curl \
  -F "name=localizable" \
  -F "title=Website" \
  -F "new_name=translatable" \
  https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}
<?php
$post_params = array();
$request_url = 'https://api.crowdin.com/api/project/{project-identifier}/change-directory?key={project-key}';
$post_params['name'] = '/localizable/texts';
$post_params['new_name'] = 'translations';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_params);

$result = curl_exec($ch);
curl_close($ch);

echo $result;

Was this article helpful?