DocumentListService - 범위가 지정됨, 전역

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기10분

    • DocumentListService API는 문서 목록을 만들고, 삭제하고, 업데이트하는 메서드를 제공합니다.

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

    플러그인은 문서 관리 문서와 연결할 문서 템플릿 목록 생성도 지원합니다. 예를 들어, 졸업장, 신분증 또는 여권과 같은 여러 문서가 필요한 입사 지원서가 있습니다. 문서 목록을 추가한 후 문서 템플릿을 추가할 수 있습니다.
    문서를 템플릿으로 정의하려면 다음을 수행합니다.
    • SystemDocument – template() 메서드를 true로 설정하여 문서 객체를 정의합니다. DocumentService API의 메서드를 사용하여 문서 기록을 만들거나 업데이트합니다.
    • 문서 [ds_document] 테이블에서 문서의 템플릿 확인란을 선택합니다.
    다음 API를 사용하여 문서를 정의하고 관리할 수 있습니다.
    문서를 템플릿으로 정의하려면 다음을 수행합니다.
    • SystemDocument – template() 메서드를 true로 설정하여 문서 객체를 정의합니다. DocumentService API의 메서드를 사용하여 문서 기록을 만들거나 업데이트합니다.
    • 문서 [ds_document] 테이블에서 문서의 템플릿 확인란을 선택합니다.

    SystemDocumentList 도 참조하십시오 .

    DocumentListService - DocumentListService()

    DocumentListService 객체를 인스턴스화합니다.

    표 1. 매개변수
    이름 유형 설명
    없음

    다음 예제에서는 DocumentListService 개체를 인스턴스화하는 방법을 보여 줍니다. SystemDocumentList 도 참조하십시오 .

    var s = new sn_doc_services.DocumentListService();

    DocumentListService - createDocumentList(SystemDocumentList 문서)

    문서 목록 [ds_document_lists] 테이블에 문서 목록을 작성합니다.

    플러그인은 문서 관리 문서와 연결할 문서 템플릿 목록 생성도 지원합니다. 예를 들어, 졸업장, 신분증 또는 여권과 같은 여러 문서가 필요한 입사 지원서가 있습니다. 문서 목록을 추가한 후 문서 템플릿을 추가할 수 있습니다.

    createDocumentsFromList() 메서드를 사용하여 문서 템플릿 목록에서 문서를 만듭니다.

    표 2. 매개변수
    이름 유형 설명
    문서 시스템 문서 목록 새 기록의 필드를 나타내는 하나 이상의 속성. name 속성은 필수이며 SystemDocumentList 생성자 또는 name() 메서드를 사용하여 설정할 수 있습니다.
    표 3. 반환
    유형 설명
    객체 문서 목록 [ds_document_lists] 테이블에 성공 메시지가 있는 새 기록의 Sys_id입니다. 그렇지 않으면 오류 메시지가 표시됩니다.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다.

    데이터 유형: 문자열
    <Object>.request_id 문서 목록 [ds_document_lists] 테이블의 기록 Sys_id입니다.

    데이터 유형: 문자열
    <Object>.상태 작업의 성공 여부를 나타내는 상태입니다.
    가능한 값:
    • success - 운영이 성공했습니다.
    • failure – 작업이 성공하지 못했습니다. message 에서 상세 정보를 제공합니다.

    데이터 유형: 문자열

    다음 예제에서는 문서 목록을 만드는 방법을 보여 줍니다. SystemDocumentList 도 참조하십시오 .

    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"
}

    DocumentListService - createDocumentsFromList(문자열 listSysId, 문자열 tableName, 문자열 tableSysId)

    문서 템플릿 목록에서 문서를 작성합니다.

    주:
    이 메서드를 사용하기 전에 createDocumentList() 메서드를 사용하여 문서 템플릿 목록을 만듭니다.
    표 4. 매개변수
    이름 유형 설명
    listSysId 문자열 문서 목록 [ds_document_lists] 테이블의 문서 목록 기록 Sys_id입니다.
    tableName 문자열 문서 템플릿 참조 목록을 추가할 기록이 포함된 테이블의 이름입니다.
    tableSysId 문자열 문서 템플릿 참조 목록을 추가할 컨텐츠를 포함하는 기록의 Sys_id입니다.
    표 5. 반환
    유형 설명
    객체 성공 또는 오류 메시지입니다. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지

    문서 목록에 있는 문서 템플릿 수가 포함된 메시지입니다.

    데이터 유형: 문자열
    <Object>.request_id 문서 목록 [ds_document_lists] 테이블의 기록 Sys_id입니다.

    데이터 유형: 문자열
    <Object>.상태 작업의 성공 여부를 나타내는 상태입니다.
    가능한 값:
    • success - 운영이 성공했습니다.
    • failure – 작업이 성공하지 못했습니다. message 에서 상세 정보를 제공합니다.

    데이터 유형: 문자열

    다음 예제에서는 기록에 문서 템플릿 참조 목록을 추가하는 방법을 보여 줍니다. 문서가 인시던트 [incident] 테이블의 기록에 추가됩니다.

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    출력:
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService - deleteDocumentList(문자열 listSysId)

    문서 목록 [ds_document_lists] 테이블에서 문서 기록을 제거합니다.

    표 6. 매개변수
    이름 유형 설명
    listSysId 문자열 문서 목록 [ds_document_lists] 테이블의 문서 목록 기록 Sys_id입니다.
    표 7. 반환
    유형 설명
    객체 성공 또는 오류 메시지입니다. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다.

    데이터 유형: 문자열
    <Object>.request_id 문서 목록 [ds_document_lists] 테이블의 기록 Sys_id입니다.

    데이터 유형: 문자열
    <Object>.상태 작업의 성공 여부를 나타내는 상태입니다.
    가능한 값:
    • success - 운영이 성공했습니다.
    • failure – 작업이 성공하지 못했습니다. message 에서 상세 정보를 제공합니다.

    데이터 유형: 문자열

    다음은 문서 목록 기록을 삭제하는 예시입니다. SystemDocumentList 도 참조하십시오 .

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    출력:
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - updateDocumentList(문자열 문서 SysId, SystemDocumentList 문서)

    기존 문서 목록의 필드 값을 업데이트합니다.

    표 8. 매개변수
    이름 유형 설명
    listSysId 문자열 문서 목록 [ds_document_lists] 테이블의 문서 목록 기록 Sys_id입니다.
    문서 시스템 문서 업데이트할 문서 목록 필드를 나타내는 하나 이상의 속성입니다.
    표 9. 반환
    유형 설명
    객체 성공 또는 오류 메시지입니다. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다.

    데이터 유형: 문자열
    <Object>.request_id 문서 목록 [ds_document_lists] 테이블의 기록 Sys_id입니다.

    데이터 유형: 문자열
    <Object>.상태 작업의 성공 여부를 나타내는 상태입니다.
    가능한 값:
    • success - 운영이 성공했습니다.
    • failure – 작업이 성공하지 못했습니다. message 에서 상세 정보를 제공합니다.

    데이터 유형: 문자열

    다음 예제에서는 문서 목록 이름 및 설명을 업데이트하는 방법을 보여 줍니다. SystemDocumentList 도 참조하십시오 .

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

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"
}