AWA 받은 편지함 작업 API

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

    • AWA 받은 편지함 작업 API는 에이전트를 대신하여 작업 항목을 수락하거나 거부하는 엔드포인트를 제공합니다. 이 API는 거부된 작업 항목에 대한 거부 사유도 검색합니다.

    이 API에는 (com.glide.awa) 플러그인과 awa_integration_user 역할이 고급 작업 할당 필요합니다. 자세한 내용은 Advanced Work Assignment를 참조하십시오.

    AWA 받은 편지함 작업 – GET /awa/inbox/actions/reject_reasons/{channel_id}

    지정된 서비스 채널에 대한 작업 항목 거부 이유를 가져옵니다.

    URL 형식

    버전이 지정된 URL: /api/now/awa/inbox/actions/reject_reasons/{channel_id}

    기본 URL: /api/now/{api_version}/awa/inbox/actions/reject_reasons/{channel_id}

    지원되는 요청 매개변수

    표 1. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    channel_id 서비스 채널 [awa_service_channel] 테이블에 나열된 서비스 채널의 Sys_id입니다. 자세한 내용은 다음 문서를 참조하십시오.
    표 2. 쿼리 매개변수
    이름 설명
    없음
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 4. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 6. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다.
    가능한 이유:
    • 사용자에게 awa_integration_user 역할이 없습니다.
    • glide.awa.enabled 속성 값이 true가 아닙니다. 이 속성은 고급 작업 할당(com.glide.awa) 플러그인이 설치된 경우 시스템 속성 [sys_property] 테이블에 나열됩니다. 자세한 내용은 Advanced Work Assignment와 함께 설치되는 구성요소를 참조하십시오.
    404 기록 없음 제공된 채널 ID가 올바르지 않습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    display_value 거부 사유 [awa_reject_reason] 테이블의 이유 필드 표시 값입니다.

    데이터 유형: 문자열
    순서 거부 사유가 에이전트 받은 편지함에 나열되는 순서입니다.

    데이터 유형: 숫자
    값 데이터베이스에 저장된 거부 사유 필드의 값입니다.

    데이터 유형: 문자열
    Sys_id 이 서비스 채널에 대한 거부 이유 Sys_id입니다. 사유는 거부 사유 [awa_reject_reason] 테이블에 나열됩니다.

    데이터 유형: 문자열

    다음 예시에서는 채팅 서비스 채널에 대한 거부 사유를 검색하는 방법을 보여줍니다.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject_reasons/27f675e3739713004a905ee515f6a7c3" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    거부된 작업과 거부 사유를 표시하는 응답 본문입니다.

    {
  "result": [
    {
      "order": 2,
      "value": "Not my expertise",
      "display_value": "Not my expertise",
      "sys_id": "31e3fa29b38023002e7b6e5f26a8dc17"
    },
    {
      "order": 1,
      "value": "Busy",
      "display_value": "Busy",
      "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
    }
  ]
}

    AWA 받은 편지함 작업 – POST /awa/inbox/actions/accept

    에이전트를 대신하여 수락 보류 중 상태의 작업 항목을 수락합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/awa/inbox/actions/accept

    기본 URL: /api/now/awa/inbox/actions/accept

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 8. 쿼리 매개변수
    이름 설명
    없음
    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    agent_id 사용자 [sys_user] 테이블에 나열된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열
    work_item_id AWA 작업 항목 [awa_work_item] 테이블에 나열된 작업 항목의 Sys_id입니다.
    작업 항목은 다음 기준을 충족해야 합니다.
    • 지정된 에이전트에 작업 항목을 할당해야 합니다.
    • 작업 항목은 수락 보류 중 상태여야 합니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 10. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 11. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 12. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다.
    가능한 이유:
    • 에이전트 ID가 없습니다.
    • 작업 항목 ID가 누락되었습니다.
    • 작업 항목이 다른 에이전트에 할당됩니다.
    • 작업 항목이 수락 보류 중 상태가 아닙니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다.
    가능한 이유:
    • 사용자에게 awa_integration_user 역할이 없습니다.
    • glide.awa.enabled 속성 값이 true가 아닙니다. 이 속성은 고급 작업 할당(com.glide.awa) 플러그인이 설치된 경우 시스템 속성 [sys_property] 테이블에 나열됩니다. 자세한 내용은 Advanced Work Assignment와 함께 설치되는 구성요소를 참조하십시오.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    documentTable 이 작업 항목에 할당된 문서를 나열하는 테이블의 이름입니다.

    데이터 유형: 문자열
    documentSysId 작업에 할당된 문서 기록의 Sys_id입니다. 필드에 이름이 지정된 documentTable 테이블에 있습니다.

    데이터 유형: 문자열
    오류 요청 프로세스 중에 발생한 오류를 설명하는 상세 정보입니다.

    데이터 유형: 객체

    "error": {
  "detail": "String",
  "message": "String"
}
    오류.상세 정보 요청 프로세스 중에 발생한 오류에 대한 상세 정보입니다.
    가능한 값:
    • 누락된 에이전트 ID: agent_id 요청 본문에 제공되지 않았습니다.
    • 누락된 작업 항목 ID: work_item_id 요청 본문에 제공되지 않았습니다.
    • 작업 항목이 다른 에이전트에 할당 됨 – 지정된 작업 항목이 지정된 에이전트에 할당되지 않습니다.
    • 잘못된 작업 항목 ID – 요청 본문에 제공된 작업 항목이 잘못되었거나 존재하지 않습니다.
    • 작업 항목이 수락 보류 중 상태가 아님 – 요청 본문에 제공된 작업 항목이 수락 보류 중 상태가 아닙니다.

    데이터 유형: 문자열
    오류.메시지 요청 프로세스 중에 발생한 오류에 대한 메시지입니다. 설명은 속성에 나와 있습니다 error.detail .

    데이터 유형: 문자열
    상태 실패한 요청의 상태입니다. 이 속성은 오류가 있는 경우에만 응답에 포함됩니다.

    유효한 값: 실패

    데이터 유형: 문자열

    cURL 요청

    다음 예제에서는 선택한 에이전트의 작업 항목 상태를 수락 보류 중에서수락됨으로 변경하는 방법을 보여 줍니다.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/accept" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
 \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
 \"work_item_id\":\"fd69abfc878b01101ae365b83cbb35fe\"
}" \
--user 'username':'password'

    응답 본문에는 작업 항목과 관련된 문서의 sys_id과 테이블이 나열됩니다.

    {
  "result": {
    "documentSysId": "57af7aec73d423002728660c4cf6a71c",
    "documentTable": "incident"
  }
}

    AWA 받은 편지함 작업 – POST /awa/inbox/actions/reject

    에이전트를 대신하여 보류 중인 수락 상태 의 작업 항목을 거부합니다. 성공하면 할당 대상 필드가 비어 있고 거부된 필드의 값은 지정된 작업 항목에 대해 예입니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/awa/inbox/actions/reject

    기본 URL: /api/now/awa/inbox/actions/reject

    지원되는 요청 매개변수

    표 13. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.

    데이터 유형: 문자열
    표 14. 쿼리 매개변수
    이름 설명
    없음
    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    agent_id 사용자 [sys_user] 테이블에 나열된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열
    reject_reason_id 이 서비스 채널에 대한 거부 이유 Sys_id입니다. 사유는 거부 사유 [awa_reject_reason] 테이블에 나열됩니다.

    데이터 유형: 문자열
    work_item_id AWA 작업 항목 [awa_work_item] 테이블에 나열된 작업 항목의 Sys_id입니다.
    작업 항목은 다음 기준을 충족해야 합니다.
    • 지정된 에이전트에 작업 항목을 할당해야 합니다.
    • 작업 항목은 수락 보류 중 상태여야 합니다.

    데이터 유형: 문자열

    헤더

    다음 요청 및 응답 헤더는 이 HTTP 작업에만 적용되거나 이 작업에 고유한 방식으로 적용됩니다. REST API에서 사용되는 일반 헤더 목록은 지원되는 REST API 헤더를 참조하세요.

    표 16. 요청 헤더
    헤더 설명
    수용 응답 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json
    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

    다음 상태 코드는 이 HTTP 작업에 적용됩니다. REST API에서 사용할 수 있는 상태 코드 목록은 REST API HTTP 응답 코드를 참조하세요.

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다.
    가능한 이유:
    • 에이전트 ID가 없습니다.
    • 작업 항목 ID가 누락되었습니다.
    • 거부 사유 ID가 없습니다.
    • 작업 항목이 다른 에이전트에 할당됩니다.
    • 작업 항목이 수락 보류 중 상태가 아닙니다.
    401 승인되지 않았습니다. 사용자 자격 증명이 잘못되었거나 전달되지 않았습니다.
    403 금지되었습니다.
    가능한 이유:
    • 사용자에게 awa_integration_user 역할이 없습니다.
    • glide.awa.enabled 속성 값이 true가 아닙니다. 이 속성은 고급 작업 할당(com.glide.awa) 플러그인이 설치된 경우 시스템 속성 [sys_property] 테이블에 나열됩니다. 자세한 내용은 Advanced Work Assignment와 함께 설치되는 구성요소를 참조하십시오.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.
    가능한 이유:
    • 잘못된 에이전트 ID – 지정된 사용자에 대한 기록이 없습니다.
    • 잘못된 거부 사유 ID – 지정된 거부 사유에 대한 기록이 없습니다.
    • 잘못된 작업 항목 ID – 지정된 작업 항목에 대한 기록이 없습니다.
    500 내부 서버 오류입니다. 요청을 처리하는 동안 예기치 않은 오류가 발생했습니다. 응답에는 오류에 대한 추가 정보가 포함되어 있습니다.

    응답 본문 매개변수(JSON 또는 XML)

    이름 설명
    agent_id 사용자 [sys_user] 테이블에 나열된 에이전트의 Sys_id입니다.

    데이터 유형: 문자열
    오류 요청 프로세스 중에 발생한 오류를 설명하는 상세 정보입니다.

    데이터 유형: 객체

    "error": {
  "detail": "String",
  "message": "String"
}
    오류.상세 정보 요청 프로세스 중에 발생한 오류에 대한 상세 정보입니다.
    가능한 값:
    • 에이전트 ID 누락 – agent_id 요청 본문에 제공되지 않았습니다.
    • 거부 사유 항목 ID 누락 – reject_reason_id 요청 본문에 제공되지 않았습니다.
    • 누락된 작업 항목 ID: work_item_id 요청 본문에 제공되지 않았습니다.
    • awa_reject_reason에 대한 기록이 없습니다. <reason_sys_id> – 요청 본문에 제공된 거부 reject_reason_id 사유 [awa_reject_reason] 테이블에 일치하는 기록이 없습니다.
    • awa_work_item에 대한 기록이 없습니다. <work_item_sys_id> – 요청 본문에 제공된 AWA work_item_id 작업 항목 [awa_work_item] 테이블에 일치하는 기록이 없습니다.
    • sys_user에 대한 기록이 없음: <agent_sys_id> – 요청 본문에 제공된 사용자 agent_id [sys_user] 테이블에 일치하는 기록이 없습니다.
    • 작업 항목이 수락 보류 중 상태가 아님: 요청 본문에 제공된 작업 항목이 수락 보류 중 이외의 상태입니다.

    데이터 유형: 문자열
    오류.메시지 요청 프로세스 중에 발생한 오류에 대한 메시지입니다. 설명은 속성에 나와 있습니다 error.detail .

    데이터 유형: 문자열
    상태 실패한 요청의 상태입니다. 이 속성은 오류가 있는 경우에만 응답에 포함됩니다.

    유효한 값: 실패

    데이터 유형: 문자열
    reject_reason_id 이 서비스 채널에 대한 거부 이유 Sys_id입니다. 사유는 거부 사유 [awa_reject_reason] 테이블에 나열됩니다.

    데이터 유형: 문자열
    work_item_id AWA 작업 항목 [awa_work_item] 테이블에 나열된 작업 항목의 Sys_id입니다.

    데이터 유형: 문자열

    다음 예제에서는 "전문 분야가 아님"을 이유로 할당된 작업 항목을 거부하는 방법을 보여 줍니다.

    curl "https://instance.service-now.com/api/now/awa/inbox/actions/reject" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"agent_id\":\"46c9e158a9fe198101d44d0d22cb640d\",
    \"work_item_id\":\"3ed5df4d87cf01101ae365b83cbb35af\",
    \"reject_reason_id\":\"31e3fa29b38023002e7b6e5f26a8dc17\"
}" \
--user 'username':'password'

    성공적인 출력에는 요청 본문에 제공된 동일한 작업 항목, 거부 사유 및 사용자 ID가 표시됩니다. AWA 작업 항목 [awa_work_item] 테이블의 지정된 작업 항목에 빈 할당 대상 필드가 있고 거부됨 필드의 값이 예입니다.

    {
  "result": {
    "work_item_id": "3ed5df4d87cf01101ae365b83cbb35af",
    "reject_reason_id": "31e3fa29b38023002e7b6e5f26a8dc17",
    "agent_id": "46c9e158a9fe198101d44d0d22cb640d"
  }
}