SystemDocumentList - 범위 지정, 전역

SystemDocumentList API는 문서 목록 [ds_document_lists] 테이블에서 레코드 필드를 설정하기 위한 메서드를 제공합니다.

이 API에는 플러그인(com.snc.platform_document_management)이 문서 관리 필요하며 sn_doc_services 네임스페이스 내에서 제공됩니다. 자세한 내용은 문서 서비스를 참조하십시오.

문서 목록을 만들거나 관리하려면 DocumentListService API를 사용합니다.

SystemDocumentList - SystemDocumentList(String docListName)

SystemDocumentList 개체를 인스턴스화합니다.

표 1. 매개변수

이름	유형	설명
docList이름	문자열	문서 목록의 이름입니다.

표 2. 반환

유형	설명
없음

다음 예제에서는 SystemDocumentList 개체를 인스턴스화하는 방법을 보여 줍니다.

var docList = new sn_doc_services.SystemDocumentList();

SystemDocumentList - description(description 문자열)

새 문서 목록 기록의 설명 필드를 설정합니다.

표 3. 매개변수

이름	유형	설명
설명	문자열	문서 목록에 대한 설명입니다.

표 4. 반환

유형	설명
없음

다음 예제에서는 문서 목록에 설명을 추가하는 방법을 보여 줍니다. DocumentListService API도 참조하세요.

var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));

출력:

{
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

SystemDocumentList - name(String docListName)

문서 목록 기록의 이름 필드를 설정합니다.

주:

SystemDocumentList() 생성자에서 이름을 매개 변수로 설정할 수도 있습니다.

표 5. 매개변수

이름	유형	설명
docList이름	문자열	문서 목록의 이름입니다.

표 6. 반환

유형	설명
없음

다음 예제에서는 기존 문서 목록의 이름을 바꾸는 방법을 보여 줍니다. DocumentListService도 참조하세요.

var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';
var docListUpdate = new sn_doc_services.SystemDocumentList();

docListUpdate.name('name change');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));

출력:

{
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}