revision

이 자원을 사용하여 프로세스, 정책 또는 의사결정의 변경내용을 작성하거나 변경내용을 조회할 수 있습니다.

참고: API 문서가 IBM API 허브로 이전되었습니다 외부 링크는 새 창 또는 새 탭에서 열립니다. API Hub에서 API에 Blueworks Live 대한 최신 업데이트 및 문서를 확인하세요.

메소드 요약

HTTP 메소드 경로 설명
GET /scr/api/revision/[process|policy|decision]/{artifact_id} 프로세스, 정책 또는 의사결정에 대한 변경내용 목록을 검색합니다. 기본 조회는 사용자가 작성한 변경내용만 검색합니다.
POST /scr/api/revision/[process|policy|decision]/{artifact_id} 프로세스, 정책 또는 의사결정의 현재 팁에 대한 변경내용을 작성합니다.

GET/scr/api/revision/[process|policy|decision]/{artifact_id}

설명
프로세스, 정책 또는 의사결정에 대한 변경내용 목록을 검색하려면 이 메소드를 사용하십시오.
자원 정보
요구 사항 설명
응답 형식 JSON
인증 필요 예. 사용자는 프로세스, 정책 또는 의사결정의 편집자여야 합니다.
OAuth 2 클라이언트 신임 정보 지원 아티팩트 보고 카테고리를 포함하는 사용자 서비스 ID를 사용하여 예
비율 제한됨 아니오
매개변수
이름 위치 설명 필수 유형
X-On-Behalf-Of 헤더 사용자 컨텍스트입니다. 값은 계정의 사용자 이름이어야 합니다. 사용자에게 계정 및 지정된 상위 공간(있는 경우)에서 조치를 수행할 수 있는 권한이 있어야 합니다. 서비스 ID OAuth 자격 증명을 사용하는 경우 필수입니다. 사용자 서비스 ID OAuth 자격 증명을 사용할 때는 필요하지 않습니다. 문자열
artifact_id 경로 변경내용이 리턴되는 아티팩트의 ID입니다. 예 문자열
showAll 조회 이 매개변수가 true로 설정되어 있는 경우 프로세스 또는 의사결정에 대한 모든 변경내용(시스템 작성 변경내용 포함)이 리턴됩니다. 그렇지 않으면 사용자 작성 변경내용만 리턴됩니다. 기본값은 false입니다. 아니오 부울
응답
예제 1 입력
ID 130024인 프로세스에 대한 모든 사용자 작성 변경내용 가져오기:
  • 사용자 서비스 ID OAuth 2 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/revision/process/130024"
  • 서비스 ID OAuth 를 사용하여 2개의 클라이언트 자격 증명:
    curl -i -H "Authorization: Bearer access_token 
 "https://your_server_url/scr/api/revision/process/130024"
  • 서비스 ID OAuth 를 사용하여 사용자 컨텍스트가 포함된 2개의 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/revision/process/130024"
예제 1 출력

ID 130024인 프로세스에 대한 모든 사용자 작성 변경내용 가져오기:

 HTTP/1.1 200 OK
 {
   "creationTime": "2013-01-14T07:22:03-0500",
   "id": "130024",
   "hasDiagram": "true",
   "lastModified": "2013-01-14T07:51:22-0500",
   "revisions": [
      {
         "id": "130089",
         "hasDiagram": "true",
         "label": "Second Snapshot",
         "time": "2013-01-14T07:51:22-0500",
         "revisionType": "userSnapshot"
      },
      {
         "id": "130065",
         "hasDiagram": "true",
         "label": "First Snapshot",
         "time": "2013-01-14T07:48:00-0500",
         "revisionType": "userSnapshot"
      }
   ],
   "tip": "130089"
}
예제 2 입력
ID가 130024인 프로세스에 대한 모든 변경내용 가져오기:
  • 사용자 서비스 ID OAuth 2 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" 
    "https://your_server_url/scr/api/revision/process/130024?showAll=true"
  • 서비스 ID OAuth 를 사용하여 2개의 클라이언트 자격 증명:
    curl -i -H "Authorization: Bearer access_token 
"https://your_server_url/scr/api/revision/process/130024?showAll=true"
  • 서비스 ID OAuth 를 사용하여 사용자 컨텍스트가 포함된 2개의 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" -H "X-On-Behalf-Of:user_name@domain.com" 
    "https://your_server_url/scr/api/revision/process/130024?showAll=true"
예제 2 출력

ID가 130024인 프로세스에 대한 모든 변경내용 가져오기:

 HTTP/1.1 200 OK
 {
   "creationTime": "2013-01-14T07:22:03-0500",
   "id": "130024",
   "hasDiagram": "true",
   "lastModified": "2013-01-14T07:51:22-0500",
   "revisions": [
      {
         "id": "130089", 
         "hasDiagram": "true",
         "label": "Second Snapshot",
         "time": "2013-01-14T07:51:22-0500",
         "revisionType": "userSnapshot"
      },
      {
         "id": "130065", 
         "hasDiagram": "true",
         "label": "First Snapshot",
         "time": "2013-01-14T07:48:00-0500",
         "revisionType": "userSnapshot"
      },
      {
         "id": "130055",
         "hasDiagram": "false",
         "label": "Before diagram creation",
         "time": "2013-01014T07:20:22-0500",
         "revisionType": "systemSnapshot"
      },
   ],
   "tip": "130089"
}
응답 특성
creationTime
프로세스 또는 정책이 작성된 시간입니다.
id
프로세스, 정책 또는 의사결정의 ID입니다. 이 ID는 요청 URI에 제공되는 artifact_id입니다. artifact_id는 각 변경내용에 대한 ID가 됩니다.
hasDiagram
프로세스에 다이어그램이 있는지 여부입니다. 이 특성은 프로세스에 대해서만 유효합니다.
lastModified
프로세스, 정책 또는 의사결정이 마지막으로 수정된 시간입니다.
revisions
프로세스, 정책 또는 의사결정의 변경내용 목록입니다. 이 목록은 역시간 순서로 구성됩니다.
revisions.hasDiagram
변경내용에 다이어그램이 있는지 여부입니다. 이 특성은 프로세스에 대해서만 유효합니다.
revisions.id
변경내용의 ID입니다.
revisions.label
snapshot 또는 변경내용이 작성되었을 때 변경내용에 지정된 레이블입니다.
revisions.revisionType
변경내용의 유형입니다(예: userSnapshot 또는 systemSnapshot).
revisions.time
변경내용이 작성된 시간입니다.
tip
프로세스의 현재 팁입니다. 최신 변경내용이 팁과 같은지 여부를 판별합니다. 이전 출력 예에서는 동일합니다.
응답 메시지
HTTP 코드 원인
JSON 페이로드를 포함한 200

요청이 완료되었습니다.
400 URI 구문이 올바르지 않거나 제공된 ID의 아티팩트가 존재하지 않습니다.
401

사용자에게 요청 작성 권한이 부여되지 않았습니다.
403
액세스가 금지되었습니다. 이 메시지는 다음 이유 중 하나로 표시될 수 있습니다.
  • 지정된 신임 정보가 유효하지 않습니다.
  • 이 사용자는 이 프로세스의 편집자가 아닙니다.
  • 관리자가 API를 사용으로 설정하지 않았습니다. 계정 정보 탭에서 API를 사용으로 설정해야 합니다.
  • 관리자가 서비스의 이용 약관을 승인하지 않았습니다.

POST/scr/api/revision/[process|policy|decision]/{artifact_id}

설명
프로세스, 정책 또는 의사결정의 현재 팁에 대한 새 변경내용을 작성하려면 이 메소드를 사용하십시오.
자원 정보
요구 사항 설명
응답 형식 JSON
인증 필요 예. 사용자는 프로세스, 정책 또는 의사결정의 편집자여야 합니다.
OAuth 2 클라이언트 신임 정보 지원 아티팩트 보고 카테고리를 포함하는 사용자 서비스 ID를 사용하여 예
비율 제한됨 아니오
매개변수
이름 위치 설명 필수 유형
X-IBM-API-Version 헤더 요청된 API 버전은 20160630입니다. 예 문자열
X-On-Behalf-Of 헤더 사용자 컨텍스트입니다. 값은 계정의 사용자 이름이어야 합니다. artifact_id 매개변수로 식별되는 아티팩트에 대해 계정에 스냅샷을 작성할 수 있는 권한이 사용자에게 있어야 합니다. 서비스 ID OAuth 자격 증명을 사용하는 경우 필수입니다. 사용자 서비스 ID OAuth 자격 증명을 사용할 때는 필요하지 않습니다. 문자열
artifact_id 경로 변경내용이 리턴되는 아티팩트의 ID입니다. 예 문자열
label 조회 변경내용에 대한 이 레이블은 URI 인코딩되어야 합니다. 예 문자열
응답
출력 예
이름이 Third Snapshot인 프로세스 130054의 팁에 대한 개정판 작성:
  • 사용자 서비스 ID OAuth 2 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" -H "X-IBM-API-Version:20160630" 
    -X POST "https://your_server_url/scr/api/revision/process/130054?label=Third%20Snapshot"
  • 서비스 ID OAuth 를 사용하여 2개의 클라이언트 자격 증명:
    curl -i -H "Authorization: Bearer access_token" -H "X-IBM-API-Version:20160630" 
    -X POST "https://your_server_url/scr/api/revision/process/130054?label=Third%20Snapshot"
  • 서비스 ID OAuth 를 사용하여 사용자 컨텍스트가 포함된 2개의 클라이언트 자격 증명 사용:
    curl -i -H "Authorization: Bearer access_token" -H "X-IBM-API-Version:20160630" -H "X-On-Behalf-Of:user_name@domain.com" 
    -X POST "https://your_server_url/scr/api/revision/process/130054?label=Third%20Snapshot"
예제 출력
이름이 Third Snapshot인 프로세스 130054의 팁에 대한 개정판 작성:
HTTP/1.1 200 OK
Content-Length: 180
{
   "id": "1300a1",
   "label": "Third Snapshot",
   "time": "2013-01-14T08:08:22-0500"
}
응답 특성
id
작성된 변경내용의 ID입니다.
label
작성된 변경내용의 레이블입니다.
time
변경내용이 작성된 시간입니다.
응답 메시지
HTTP 코드 원인
JSON 페이로드를 포함한 200

요청이 완료되었습니다.
400 URI 구문이 올바르지 않거나 제공된 ID의 아티팩트가 존재하지 않습니다.
401

사용자에게 요청 작성 권한이 부여되지 않았습니다.
403
액세스가 금지되었습니다. 이 메시지는 다음 이유 중 하나로 표시될 수 있습니다.
  • 지정된 신임 정보가 유효하지 않습니다.
  • 이 사용자는 이 프로세스의 편집자가 아닙니다.
  • 관리자가 API를 사용으로 설정하지 않았습니다. 계정 정보 탭에서 API를 사용으로 설정해야 합니다.
  • 관리자가 서비스의 이용 약관을 승인하지 않았습니다.