DocumentService - 범위 지정, 전역

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기7분

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

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

    문서는 문서 기록에 대한 정보의 모음입니다. 레코드를 만들거나 업데이트하는 데 사용되는 메서드는 SystemDocument 개체를 사용하여 필드를 수정합니다.

    문서 컨텐츠는 버전을 사용하여 관리됩니다. 다음 API를 사용하여 문서 버전을 정의하고 관리할 수 있습니다.
    • SystemDocumentVersion – 문서 버전을 문서 내용의 소스로 정의합니다. 각 버전은 문서 컨텐츠를 포함하는 요소이며 단일 URL 또는 첨부 파일을 사용하여 제공됩니다. 첨부 파일은 문서 버전 [ds_document_version] 테이블 UI에서만 추가할 수 있고 API를 사용해서는 추가할 수 없습니다.
    • DocumentVersionService – 문서 콘텐츠는 버전을 사용하여 관리됩니다.

    DocumentReferenceService API를 사용하여 인시던트 [incident] 또는 Knowledge [kb_knowledge] 테이블과 같은 대상 테이블에서 참조되는 문서를 관리합니다.

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

    DocumentService - DocumentService()

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

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

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

    var s = new sn_doc_services.DocumentService();

    DocumentService - createDocument(SystemDocument doc)

    문서 [ds_document] 테이블에 문서 기록을 만듭니다.

    표 2. 매개변수
    이름 유형 설명
    문서 시스템 문서 새 기록의 필드를 나타내는 하나 이상의 속성입니다. name 속성은 필수이며 SystemDocument 생성자 또는 name() 메서드를 사용하여 설정할 수 있습니다.
    표 3. 반환
    유형 설명
    객체 성공 메시지와 함께 문서 [ds_document] 테이블의 새 레코드 Sys_id. 그렇지 않으면 오류 메시지입니다.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다.
    가능한 값:
    • 문서 sysId 작성: &lt;sys_id> 성공했습니다.
    • 문서 이름은 필수이며 유효해야 합니다.
    • 문서 이름은 필수이며 null이거나 비워둘 수 없습니다.
    • &lt;sys_id 입력이 필요한 SystemDocument 속성> SysId: &quot;&lt;sys_id>&quot;이 없습니다.

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

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

    데이터 유형: 문자열

    다음 예제에서는 SystemDocument 개체 속성을 채우고 새 문서 레코드를 만드는 방법을 보여 줍니다.

    var d = new sn_doc_services.SystemDocument('My document');

// Define the document fields
var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.description('description');
d.classification('restricted');
d.state('review');
d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
d.template(false);
d.type('policy');
d.reviewers(reviewers);
d.audience('external');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    출력:
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    DocumentService - deleteDocument(docSysId 문자열)

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

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

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

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

    데이터 유형: 문자열

    다음 예제에서는 기존 문서 기록을 삭제하는 방법을 보여 줍니다.

    var docid = "<sys_id>";
var svc = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(svc.deleteDocument(docid), null, 2));
    출력:
    {
  "message": "Delete document sysId : <sys_id> is successful.",
  "request_id": "<sys_id>",
  "status": "success"
}

    DocumentService - updateDocument(String docSysId, SystemDocument doc)

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

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

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

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

    데이터 유형: 문자열

    다음 예제에서는 문서 이름을 변경하는 방법을 보여 줍니다. SystemDocument도 참조하십시오.

    var dId = "19aab54e24103410f877a6fed1c2b03d";
var d = new sn_doc_services.SystemDocument();
d.name("c22.txt");

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.updateDocument(dId, d), null, 2));
    출력:
    {
  "message": "Update document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}