DocumentVersionService - 범위가 지정됨, 전역

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

    • DocumentVersionService API는 문서 버전을 만들고 삭제하기 위한 서비스를 제공합니다. 각 버전은 문서 콘텐츠를 포함하는 요소이며 단일 URL 또는 첨부 파일을 사용하여 제공됩니다. 첨부 파일은 문서 버전 [ds_document_version] 테이블 UI에만 추가할 수 있으며 API에는 추가할 수 없습니다.

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

    문서 버전을 생성하기 전에 먼저 문서 기록을 정의하고 추가해야 합니다.

    DocumentVersionService - DocumentVersionService()

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

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

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

    var versionSvc = new sn_doc_services.DocumentVersionService();

    DocumentVersionService - createDocumentVersion(SystemDocumentVersion, docVersion)

    버전 [ds_document_version] 테이블에 문서 버전 기록을 작성합니다.

    표 2. 매개변수
    이름 유형 설명
    docVersion SystemDocumentVersion (영문) 문서 버전의 필드를 나타내는 하나 이상의 속성입니다.
    표 3. 반환
    유형 설명
    객체 버전 [ds_document_version] 테이블에 성공 메시지가 있는 새 기록의 Sys_id입니다. 그렇지 않으면 오류 메시지가 표시됩니다.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다. 성공하면 문서 기록의 sys_id과 새 문서 버전의 sys_id이 포함됩니다.

    데이터 유형: 문자열
    <Object>.request_id 버전 [ds_document_version] 테이블에 있는 새 기록의 Sys_id입니다.

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

    데이터 유형: 문자열

    다음 예제에서는 SystemDocumentVersion 개체 속성을 채우고 새 문서 버전을 만드는 방법을 보여 줍니다. SystemDocumentVersion 도 참조하십시오 .

    var versionDefinition = new sn_doc_services.SystemDocumentVersion('491efbee24187410f877a6fed1c2b0a9');

versionDefinition.type('url');
versionDefinition.url('http://one/1.0');

var versionSvc = new sn_doc_services.DocumentVersionService();
gs.info(JSON.stringify(versionSvc.createDocumentVersion(versionDefinition), null, 2));
    출력:
    {
  "message": "Adding an entry to DocumentVersion for the given docId : 491efbee24187410f877a6fed1c2b0a9, sysId : d5a340d9242cf810f877a6fed1c2b069 is successful.",
  "request_id": "d5a340d9242cf810f877a6fed1c2b069",
  "status": "success"
}

    DocumentVersionService - deleteDocumentVersion(문자열 docVersionSysId)

    문서 버전을 삭제합니다.

    표 4. 매개변수
    이름 유형 설명
    docVersionSysId 문자열 버전 [ds_document_version] 테이블의 문서 버전 Sys_id입니다.
    표 5. 반환
    유형 설명
    객체 성공 메시지입니다. 그렇지 않으면 오류 메시지가 표시됩니다.
    {
  "message": "String",
  "status": "String"
}
    <Object>.메시지 성공 또는 오류를 확인하는 메시지입니다. 성공하면 삭제된 문서 버전의 sys_id 포함됩니다.

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

    데이터 유형: 문자열

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

    var vId = "<versionSysId>";
var versionSvc = new sn_doc_services.DocumentVersionService();

gs.info(JSON.stringify(versionSvc.deleteDocumentVersion(vId), null, 2));
    출력:
    {
  "message": "Deleting an entry to DocumentVersion for the given documentVersionSysId : , sysId : <versionSysId> is successful.",
  "status": "success"
}