시트 사용가능 설정
URL 엔드포인트
HTTPS://api.adaptiveinsights.com/api/rest/modeling/<version>/<tenant>/sheet/availability
버전: v1
카테고리 | 메타데이터 수정 |
설명 | 지정된 시트 및 열에 대한 디멘션 또는 특성 값 사용가능 설정을 검색하거나 업데이트합니다. |
호출에 필요한 권한 | |
요청 시 필수 매개변수 | sheetName, columnName |
지원되는 HTTP 동사
HTTP Verb | 단일 리소스 | 수금 리소스 | 설명 |
|---|---|---|---|
GET
| 미지원 | 지원됨 | 지정된 시트 및 열에 대한 모든 값의 사용가능 설정을 검색합니다. |
POST
| 미지원 | 지원됨 | 지정된 시트 및 열의 값 사용가능 설정을 업데이트합니다. |
옵션
| 지원됨 | 지원됨 | 이 컬렉션 리소스에 대해 지원되는 HTTP Verb 목록을 반환합니다. |
GET:
- 요청:
- /sheet/availability:값 사용가능 설정 컬렉션을 검색합니다.시트 디멘션에서 모든 값의 사용가능 설정을 검색합니다. instanceCode, sheetName 및 columnName을 기준으로 필터링할 수 있습니다.샘플 요청 URI:HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level샘플 요청 헤더:Accept-Language: ko샘플 요청 본문쿼리 매개변수이름설명필수sheetName가능일정 값을 검색할 시트의 이름입니다.예columnName가능일정 값을 검색할 시트 열의 이름입니다. 큐브 시트에만 필수입니다.값 사용가능 설정을 수정할 수 있는 열만 지원됩니다.큐브 시트 계정 및 레벨 열의 경우 열 이름은 Accept-Language 헤더에 설정된 로케일을 따릅니다.예columnCode가능일정 값을 검색할 시트 열의 코드입니다. 모델링 시트에만 필수입니다.값 사용가능 설정을 수정할 수 있는 열만 지원됩니다.예columnType지정된 columnName 또는 columnCode에 대한 열 유형입니다.사용가능한 값: 계정, 레벨, 디멘션, 특성예instanceCode값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.아니요limit단일 응답의 최대 오브젝트 수입니다.아니요offset응답 컬렉션에 있는 첫 번째 오브젝트의 인덱스(0부터 시작)입니다. 기본값은 0입니다.오프셋을 한도 매개변수와 함께 사용하여 응답 컬렉션의 페이징을 제어합니다.아니요
- 샘플 응답
- 200응답이 완료되었습니다.샘플 응답{ "data": [ { "code": "Corporate Plan", "name": "Corporate Plan", "available": true }, { "code": "Engineering", "name": "Engineering", "available": true }, { "code": "Development", "name": "Development", "available": true }, { "code": "Documentation", "name": "Documentation", "available": true }, { "code": "QA", "name": "QA", "available": true }, { "code": "2014-Development Organization", "name": "2014-Development Organization", "available": false }, { "code": "Development-India", "name": "Development-India", "available": false }, { "code": "QA-India", "name": "QA-India", "available": false }, { "code": "G & A", "name": "G & A", "available": false }, { "code": "Hosting", "name": "Hosting", "available": true }, { "code": "Professional Services", "name": "Professional Services", "available": true }, { "code": "Sales", "name": "Sales", "available": true }, { "code": "Marketing", "name": "Marketing", "available": true }, { "code": "US Sales", "name": "US Sales", "available": false }, { "code": "Worldwide Sales", "name": "Worldwide Sales", "available": true }, { "code": "Asia Sales", "name": "Asia Sales", "available": false }, { "code": "Europe Sales", "name": "Europe Sales", "available": true }, { "code": "Latin America Sales", "name": "Latin America Sales", "available": true } ], "total": 18 }
POST:
- 요청:
- /sheet/availability:값 사용가능 설정 컬렉션을 업데이트합니다.시트 디멘션에 있는 모든 값의 사용가능 설정을 업데이트합니다.샘플 요청 URI:https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level샘플 요청 헤더:Accept-Language: ko요청 본문:내보내기의 'data' 속성과 일치하는 사용가능 설정 오브젝트의 JSON 배열입니다. 각 JSON 오브젝트의 구조는 다음과 같습니다.이름설명필수코드값의 코드입니다. 값을 고유하게 식별하는 데 사용됩니다.예이름값의 이름입니다.예accountGroup값이 계정 그룹인지 여부 계정의 경우 필수입니다.아니요사용가능값을 사용할 수 있는지 여부 없는 경우 변경되지 않습니다.아니요deleteIfDataIsPresent데이터가 있는 경우 삭제할지 여부 큐브 시트에서 커스텀 디멘션 값을 비활성화하는 경우 필수입니다.아니요actionIfDataIsPresent데이터가 있는 경우 수행할 액션입니다. 모델링 시트에서 커스텀 디멘션 값을 비활성화하는 경우 필수입니다.아니요
- 샘플 요청 본문
- 요청 본문[ { "code": "SalesCube.DiscountPercent", "name": "Discount Percent", "accountGroup": false, "available": false } ]쿼리 매개변수이름설명필수sheetName가능일정 값을 검색할 시트의 이름입니다.예columnName사용가능 설정 값을 검색할 시트 열의 이름입니다. 큐브 시트에만 필수입니다.값 사용가능 설정을 수정할 수 있는 열만 지원됩니다.큐브 시트 계정 및 레벨 열의 경우 열 이름은 Accept-Language 헤더에 설정된 로케일을 따릅니다.예columnCode가능일정을 검색할 시트 열의 코드입니다. 모델링 시트에만 필수입니다.값 사용가능 설정을 수정할 수 있는 열만 지원됩니다.예columnType지정된 columnName 또는 columnCode에 대한 열 유형입니다.사용가능한 값: 계정, 레벨, 디멘션, 특성예instanceCode값을 검색할 instanceCode입니다. 예를 들어, GLOBO입니다. instanceCode를 지정하지 않으면 사용자의 기본 인스턴스가 사용됩니다.아니요
- 샘플 응답:
- 204상태 코드 204를 사용하여 성공한 응답이 비어 있습니다.