테이블 API

  • 릴리스 버전: Xanadu
  • 업데이트 날짜 2024년 08월 01일
  • 읽기57분
  • Table API는 기존 테이블에서 CRUD(생성, 읽기, 업데이트 및 삭제) 작업을 수행할 수 있는 엔드포인트를 제공합니다.

    호출하는 사용자에게는 요청에 지정된 테이블의 데이터에 액세스할 수 있는 충분한 역할이 있어야 합니다.

    테이블 - DELETE /now/table/{tableName}/{sys_id}

    지정된 테이블에서 지정된 기록을 삭제합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}/{sys_id}

    기본 URL: /api/now/table/{tableName}/{sys_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열

    sys_id 삭제할 기록의 Sys_id입니다.

    데이터 유형: 문자열

    tableName "인시던트" 또는 "자산"과 같이 지정된 기록을 삭제할 테이블의 이름입니다.

    데이터 유형: 문자열

    표 2. 쿼리 매개변수
    이름 설명
    sysparm_query_no_domain 로그인한 사용자가 구성된 도메인으로만 기록 검색을 제한할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우 기록을 제외합니다.
    • true: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우에도 기록을 포함합니다.

    데이터 유형: 부울

    기본값: false

    주:
    sysparm_query_no_domain 매개변수는 시스템 관리자 또는 query_no_domain_table_api 역할을 가진 사용자만 사용할 수 있습니다.
    표 3. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json

    표 5. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 6. 상태 코드
    상태 코드 설명
    204 요청이 성공적으로 완료되었음을 나타냅니다.

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

    이름 설명
    없음

    cURL 요청

    인시던트 테이블에서 기록을 삭제합니다.

    curl "https://instance.servicenow.com/api/now/table/incident/d977b66a4f411200adf9f8e18110c7b2" \
    --request DELETE \
    --header "Accept:application/json" \
    --user 'username':'password'

    응답 본문이 없습니다.

    None

    테이블 - GET /now/table/{tableName}

    지정된 테이블에 대한 여러 기록을 조회합니다.

    기본 지침은 기존 인시던트 검색을 참조하세요.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}

    기본 URL: /api/now/table/{tableName}

    지원되는 요청 매개변수

    표 7. 경로 매개변수
    이름 설명
    api_version 옵션입니다. 액세스할 엔드포인트의 버전입니다. 예를 들면 v1 또는 v2입니다. 최신 버전이 아닌 엔드포인트 버전을 사용하려면 이 값만 지정합니다.
    버전에 따라 이 엔드포인트는 유효한 쿼리에서 다른 결과를 반환합니다.
    • 버전 1은 결과 없이 오류 코드 404를 반환합니다.
    • 버전 2는 성공 코드 200과 빈 배열을 응답 본문으로 반환합니다.

    데이터 유형: 문자열

    tableName 기록을 검색할 테이블의 이름입니다.

    데이터 유형: 문자열

    표 8. 쿼리 매개변수
    이름 설명
    이름-값 쌍 결과 집합을 필터링하는 데 사용할 이름-값 쌍입니다. 이 매개변수는 와 함께 사용할 수 없습니다 sysparm_query. 예를 들어 &sysparm_query=active=true를 사용하는 대신 &active=true를 사용하여 호출 문을 단순화할 수 있습니다. 필드가 선택 또는 참조 유형 필드인 경우에도 표시 값을 사용할 수 있습니다(예: &state=7 대신 &state=종결). 여러 키-값 쌍을 지정하려면 앰퍼샌드로 각각 구분합니다(예시: &active=true&assigned_to=john.smith).

    데이터 유형: 문자열

    sysparm_display_value 반환되는 데이터 유형(데이터베이스의 실제 값 또는 필드의 표시 값)을 결정합니다. 표시 값은 데이터베이스의 실제 값과 사용자 또는 시스템 설정 및 기본 설정에 따라 조작됩니다.
    표시 값을 반환하는 경우 반환되는 값은 필드 유형에 따라 다릅니다.
    • 선택 필드: 데이터베이스 값은 숫자일 수 있지만 표시 값은 더 설명적입니다.
    • 날짜 필드: 데이터베이스 값은 UTC 형식이고 표시 값은 사용자의 시간대를 기반으로 합니다.
    • 암호화된 텍스트: 데이터베이스 값은 암호화되지만 표시된 값은 사용자의 암호화 컨텍스트에 따라 암호화되지 않습니다.
    • 참조 필드: 데이터베이스 값은 sys_id이지만 표시 값은 참조된 기록의 표시 필드입니다.

    데이터 유형: 문자열

    유효한 값은 다음과 같습니다.

    • true: 모든 필드에 대한 표시 값을 반환합니다.
    • false: 데이터베이스에서 실제 값을 반환합니다.
    • all: 실제 값과 표시 값을 모두 반환합니다.

    기본값: false

    주:
    이 매개변수를 설정하는 기본 방법은 없습니다. 그러나 표시 값을 지정하면 데이터베이스에서 직접 읽지 않고 다른 필드와 기록을 참조하는 과정이 포함될 수 있으므로 성능 문제가 발생할 수 있습니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오.
    sysparm_fields 응답에 반환할 쉼표로 구분된 필드 목록입니다.

    데이터 유형: 문자열

    sysparm_limit 반환할 최대 기록 수입니다. 이 기록 수를 초과하는 요청의 경우 sysparm_offset 매개변수를 사용하여 기록 검색을 페이지 매김합니다.

    이 제한은 ACL 평가 전에 적용됩니다. 액세스할 수 있는 기록을 포함하여 반환되는 기록이 없으면 액세스할 수 있는 기록이 먼저 반환되도록 기록 순서를 다시 정렬합니다.

    주:
    이례적으로 큰 sysparm_limit 값은 시스템 성능에 영향을 미칠 수 있습니다.

    데이터 유형: 숫자

    기본값: 10000

    sysparm_no_count 연결된 테이블의 행 수를 반환하기 위해 테이블에서 개수 선택(*) 쿼리를 실행할지 여부를 나타내는 플래그입니다.
    유효한 값은 다음과 같습니다.
    • true: 개수 선택(*)을 실행하지 않습니다.
    • false: 개수 선택(*)을 실행합니다.

    데이터 유형: 부울

    기본값: false

    sysparm_offset 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 이 기능을 사용하면 기록 수와 관계없이 관리 가능한 작은 청크로 모든 기록을 검색할 수 있습니다.

    예를 들어 이 엔드포인트를 처음 호출할 때 sysparm_offset이 "0"으로 설정됩니다. 사용 가능한 모든 기록을 간단히 살펴보려면 모든 기록이 끝날 때까지 sysparm_offset=sysparm_offset+sysparm_limit를 사용합니다.

    매개 변수에 sysparm_offset 음수를 전달하지 마세요.

    데이터 유형: 숫자

    기본값: 0

    sysparm_query 결과 집합을 필터링하는 데 사용되는 인코딩된 쿼리입니다. UI 필터를 사용하여 올바르게 인코딩된 쿼리를 얻을 수 있습니다.
    구문은 sysparm_query=<col_name><operator><value>입니다.
    • <col_name>: 필터링할 테이블 열의 이름입니다.
    • <operator>: 다음 값을 지원합니다.
      • =: 정확히 <value>와 일치합니다.
      • !=: <value>와 일치하지 않습니다.
      • ^: 논리적으로 AND 다중 쿼리 문입니다.
      • ^OR: 논리적으로 OR 다중 쿼리 문입니다.
      • LIKE: <col_name>에 지정된 문자열이 포함되어 있습니다. 데이터 유형이 문자열인 <col_name> 필드에서만 작동합니다.
      • STARTSWITH: <col_name>은 지정된 문자열로 시작합니다. 데이터 유형이 문자열인 <col_name> 필드에서만 작동합니다.
      • ENDSWITH: <col_name>은 지정된 문자열로 끝납니다. 데이터 유형이 문자열인 <col_name> 필드에서만 작동합니다.
      <value>: 일치시킬 값입니다.

    모든 매개변수는 대/소문자를 구분합니다. 쿼리에는 sysparm_query=<col_name><operator><value>[<operator><col_name><operator><value>]와 같은 항목이 두 개 이상 포함될 수 있습니다.

    예:

    (sysparm_query=caller_id=javascript:gs.getUserID()^active=true)

    인코딩된 쿼리는 기능별 순서도 지원합니다. 특정 필드를 기반으로 응답을 정렬하려면 sysparm_queryORDERBYORDERBYDESC 절을 사용합니다.

    구문:
    • ORDERBY<col_name>
    • ORDERBYDESC<col_name>

    예: sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory

    이 쿼리는 모든 활성 기록을 필터링하고 결과를 숫자별로 오름차순으로 정렬한 다음 범주별로 내림차순으로 정렬합니다.

    잘못된 필드 이름을 지정하는 등 쿼리의 일부가 잘못된 경우 인스턴스는 잘못된 부분을 무시합니다. 그런 다음 쿼리의 유효한 부분만 사용하여 행을 반환합니다. glide.invalid_query.returns_no_rows 속성을 사용하여 이 동작을 제어할 수 있습니다. 잘못된 쿼리에 행을 반환하지 않으려면 이 속성을 true로 설정합니다.
    주:
    glide.invalid_query.returns_no_rows 속성은 목록, 스크립트(GlideRecord.query()) 및 웹 서비스 API 등 인스턴스 전체에서 모든 쿼리 동작을 제어합니다.

    데이터 유형: 문자열

    sysparm_query_category 쿼리에 사용할 범주의 이름입니다.

    데이터 유형: 문자열

    sysparm_query_no_domain 로그인한 사용자가 구성된 도메인으로만 기록 검색을 제한할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우 기록을 제외합니다.
    • true: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우에도 기록을 포함합니다.

    데이터 유형: 부울

    기본값: false

    주:
    sysparm_query_no_domain 매개변수는 시스템 관리자 또는 query_no_domain_table_api 역할을 가진 사용자만 사용할 수 있습니다.
    sysparm_suppress_pagination_header 응답에서 링크 헤더를 제거할지 여부를 나타내는 플래그입니다. 링크 헤더는 반환된 기록 세트를 페이지 매김하는 데 사용할 수 있는 기록 세트의 상대 페이지에 다양한 URL을 제공합니다.

    유효한 값은 다음과 같습니다.

    • true: 응답에서 링크 헤더를 제거합니다.
    • false: 응답에서 링크 헤더를 제거하지 않습니다.

    데이터 유형: 부울

    기본값: false

    sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

    유효한 값은 다음과 같습니다.

    • 데스크톱
    • 모바일
    • 모두

    sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

    데이터 유형: 문자열

    표 9. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json

    표 11. 응답 헤더
    헤더 설명
    링크 이전 요청을 기반으로 사용 가능한 기록 세트를 페이징하는 데 사용할 수 있는 상대 URL입니다.

    예:

    https://<인스턴스 이름>.servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>; rel="다음",

    https://<인스턴스 이름>.servicenow.com/api/now/table/cmdb_ci?sysparm_offset=40&sysparm_limit=1000>; rel="이전",

    https://<인스턴스 이름>.servicenow.com/api/now/table/cmdb_ci?sysparm_offset=0&sysparm_limit=1000>; rel="첫 번째",

    https://<인스턴스 이름>.servicenow.com/api/now/table/cmdb_ci?sysparm_offset=2780&sysparm_limit=1000>; rel="마지막"

    매개변수에 rel 대한 자세한 내용은 을 https://html.spec.whatwg.org/multipage/links.html#linkTypes참조하십시오.
    X-Total-Count 쿼리에서 반환된 총 기록 수입니다.

    상태 코드

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

    표 12. 상태 코드
    상태 코드 설명
    200 요청이 성공적으로 완료되었습니다. 유효한 쿼리가 결과를 반환하지 않으면 응답 본문에는 빈 결과 배열만 포함됩니다.

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

    매개변수 설명
    이름-값 쌍 지정된 기록 내의 모든 매개변수 또는 쿼리 매개변수에 지정된 매개변수의 필드 이름과 값입니다.

    cURL 요청

    문제 테이블에서 첫 번째 기록을 검색합니다.

    curl "https://instance.servicenow.com/api/now/table/problem?sysparm_limit=1" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    응답에는 요청된 레코드에 대한 이름-값 쌍이 포함되어 있습니다.

    {
      "result": [
        {
          "parent": "",
          "made_sla": "true",
          "watch_list": "",
          "upon_reject": "cancel",
          "sys_updated_on": "2016-01-19 04:52:04",
          "approval_history": "",
          "number": "PRB0000050",
          "sys_updated_by": "glide.maint",
          "opened_by": {
            "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
            "value": "glide.maint"
          },
          "user_input": "",
          "sys_created_on": "2016-01-19 04:51:19",
          "sys_domain": {
            "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
            "value": "global"
          },
          "state": "4",
          "sys_created_by": "glide.maint",
          "knowledge": "false",
          "order": "",
          "closed_at": "2016-01-19 04:52:04",
          "cmdb_ci": {
            "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/55b35562c0a8010e01cff22378e0aea9",
            "value": "55b35562c0a8010e01cff22378e0aea9"
          },
          "delivery_plan": "",
          "impact": "3",
          "active": "false",
          "work_notes_list": "",
          "business_service": "",
          "priority": "4",
          "sys_domain_path": "/",
          "time_worked": "",
          "expected_start": "",
          "rejection_goto": "",
          "opened_at": "2016-01-19 04:49:47",
          "business_duration": "1970-01-01 00:00:00",
          "group_list": "",
          "work_end": "",
          "approval_set": "",
          "wf_activity": "",
          "work_notes": "",
          "short_description": "Switch occasionally drops connections",
          "correlation_display": "",
          "delivery_task": "",
          "work_start": "",
          "assignment_group": "",
          "additional_assignee_list": "",
          "description": "Switch occasionally drops connections",
          "calendar_duration": "1970-01-01 00:02:17",
          "close_notes": "updated firmware",
          "sys_class_name": "problem",
          "closed_by": "",
          "follow_up": "",
          "sys_id": "04ce72c9c0a8016600b5b7f75ac67b5b",
          "contact_type": "phone",
          "urgency": "3",
          "company": "",
          "reassignment_count": "",
          "activity_due": "",
          "assigned_to": "",
          "comments": "",
          "approval": "not requested",
          "sla_due": "",
          "comments_and_work_notes": "",
          "due_date": "",
          "sys_mod_count": "1",
          "sys_tags": "",
          "escalation": "0",
          "upon_approval": "proceed",
          "correlation_id": "",
          "location": ""
        }
      ]
    }

    테이블 - GET /now/table/{tableName}/{sys_id}

    지정된 테이블에서 지정된 sys_id로 식별된 기록을 조회합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}/{sys_id}

    기본 URL: /api/now/table/{tableName}/{sys_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열

    sys_id 검색할 기록의 Sys_id입니다.

    데이터 유형: 문자열

    tableName 기록을 검색할 테이블의 이름입니다.

    데이터 유형: 문자열

    표 14. 쿼리 매개변수
    이름 설명
    sysparm_display_value 반환되는 데이터 유형(데이터베이스의 실제 값 또는 필드의 표시 값)을 결정합니다. 표시 값은 데이터베이스의 실제 값과 사용자 또는 시스템 설정 및 기본 설정에 따라 조작됩니다.
    표시 값을 반환하는 경우 반환되는 값은 필드 유형에 따라 다릅니다.
    • 선택 필드: 데이터베이스 값은 숫자일 수 있지만 표시 값은 더 설명적입니다.
    • 날짜 필드: 데이터베이스 값은 UTC 형식이고 표시 값은 사용자의 시간대를 기반으로 합니다.
    • 암호화된 텍스트: 데이터베이스 값은 암호화되지만 표시된 값은 사용자의 암호화 컨텍스트에 따라 암호화되지 않습니다.
    • 참조 필드: 데이터베이스 값은 sys_id이지만 표시 값은 참조된 기록의 표시 필드입니다.

    데이터 유형: 문자열

    유효한 값은 다음과 같습니다.

    • true: 모든 필드에 대한 표시 값을 반환합니다.
    • false: 데이터베이스에서 실제 값을 반환합니다.
    • all: 실제 값과 표시 값을 모두 반환합니다.

    기본값: false

    주:
    이 매개변수를 설정하는 기본 방법은 없습니다. 그러나 표시 값을 지정하면 데이터베이스에서 직접 읽지 않고 다른 필드와 기록을 참조하는 과정이 포함될 수 있으므로 성능 문제가 발생할 수 있습니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오.
    sysparm_exclude_reference_link 참조 필드에 대한 테이블 API 링크를 제외할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • true: 참조 필드에 대한 테이블 API 링크를 제외합니다.
    • false: 참조 필드에 대한 테이블 API 링크를 포함합니다.

    데이터 유형: 부울

    기본값: false

    sysparm_fields 응답에 반환할 쉼표로 구분된 필드 목록입니다.

    데이터 유형: 문자열

    sysparm_query_no_domain 로그인한 사용자가 구성된 도메인으로만 기록 검색을 제한할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우 기록을 제외합니다.
    • true: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우에도 기록을 포함합니다.

    데이터 유형: 부울

    기본값: false

    주:
    sysparm_query_no_domain 매개변수는 시스템 관리자 또는 query_no_domain_table_api 역할을 가진 사용자만 사용할 수 있습니다.
    sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

    유효한 값은 다음과 같습니다.

    • 데스크톱
    • 모바일
    • 모두

    sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

    데이터 유형: 문자열

    표 15. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    없음

    헤더

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

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

    기본값: application/json

    표 17. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 18. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    매개변수 설명
    이름-값 쌍 지정된 기록 내의 모든 매개변수 또는 쿼리 매개변수에 지정된 매개변수의 필드 이름과 값입니다.

    cURL 요청

    인시던트 테이블에서 기록을 검색합니다.

    curl "https://instance.servicenow.com/api/now/table/incident/a9e30c7dc61122760116894de7bcc7bd" \
    --request GET \
    --header "Accept:application/json" \
    --user 'username':'password'

    응답에는 요청된 레코드에 대한 이름-값 쌍이 포함되어 있습니다.

    {
      "result": {
        "upon_approval": "",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/105cf7f3c611227501e75e08b14a38ba",
          "value": "105cf7f3c611227501e75e08b14a38ba"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "3",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "3",
        "delivery_plan": "",
        "sys_mod_count": "4",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2015-11-11 22:04:15",
        "delivery_task": "",
        "sys_updated_on": "2015-11-01 22:37:27",
        "parent": "",
        "work_end": "",
        "number": "INC0000046",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "software",
        "business_duration": "",
        "incident_state": "1",
        "activity_due": "",
        "correlation_display": "",
        "company": "",
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a4dde73c6112278017a6a4baf547aa7",
          "value": "8a4dde73c6112278017a6a4baf547aa7"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
          "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
        },
        "knowledge": "false",
        "made_sla": "false",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "1",
        "user_input": "",
        "sys_created_on": "2015-11-01 22:05:30",
        "approval_set": "",
        "reassignment_count": "1",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 22:04:15",
        "short_description": "Can't access SFA software",
        "order": "",
        "sys_updated_by": "glide.maint",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "",
        "approval_history": "",
        "problem_id": {
          "link": "https://instance.servicenow.com/api/now/table/problem/a9e4890bc6112276003d7a5a5c774a74",
          "value": "a9e4890bc6112276003d7a5a5c774a74"
        },
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "a9e30c7dc61122760116894de7bcc7bd",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "admin",
        "resolved_at": "",
        "assigned_to": "",
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/a9c0c8d2c6112276018f7705562f9cb0",
          "value": "a9c0c8d2c6112276018f7705562f9cb0"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/46c6f9efa9fe198101ddf5eed9adf6e7",
          "value": "46c6f9efa9fe198101ddf5eed9adf6e7"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "0",
        "comments": ""
      }
    }

    테이블 - PATCH /now/table/{tableName}/{sys_id}

    요청 본문에 포함된 이름-값 쌍으로 지정된 기록을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}/{sys_id}

    기본 URL: /api/now/table/{tableName}/{sys_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열

    sys_id 업데이트할 기록의 Sys_id입니다.

    데이터 유형: 문자열

    tableName 지정된 기록이 위치한 테이블의 이름입니다.

    데이터 유형: 문자열

    표 20. 쿼리 매개변수
    이름 설명
    sysparm_display_value 반환되는 데이터 유형(데이터베이스의 실제 값 또는 필드의 표시 값)을 결정합니다. 표시 값은 데이터베이스의 실제 값과 사용자 또는 시스템 설정 및 기본 설정에 따라 조작됩니다.
    표시 값을 반환하는 경우 반환되는 값은 필드 유형에 따라 다릅니다.
    • 선택 필드: 데이터베이스 값은 숫자일 수 있지만 표시 값은 더 설명적입니다.
    • 날짜 필드: 데이터베이스 값은 UTC 형식이고 표시 값은 사용자의 시간대를 기반으로 합니다.
    • 암호화된 텍스트: 데이터베이스 값은 암호화되지만 표시된 값은 사용자의 암호화 컨텍스트에 따라 암호화되지 않습니다.
    • 참조 필드: 데이터베이스 값은 sys_id이지만 표시 값은 참조된 기록의 표시 필드입니다.

    데이터 유형: 문자열

    유효한 값은 다음과 같습니다.

    • true: 모든 필드에 대한 표시 값을 반환합니다.
    • false: 데이터베이스에서 실제 값을 반환합니다.
    • all: 실제 값과 표시 값을 모두 반환합니다.

    기본값: false

    주:
    이 매개변수를 설정하는 기본 방법은 없습니다. 그러나 표시 값을 지정하면 데이터베이스에서 직접 읽지 않고 다른 필드와 기록을 참조하는 과정이 포함될 수 있으므로 성능 문제가 발생할 수 있습니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오.
    sysparm_fields 응답에 반환할 쉼표로 구분된 필드 목록입니다.

    데이터 유형: 문자열

    sysparm_input_display_value 표시 값 또는 실제 값을 사용하여 필드 값을 설정할지 여부를 나타내는 플래그입니다. 다양한 유형의 필드에 따라 엔드포인트는 전달된 표시 값을 조작하여 데이터베이스에 적절한 값을 저장할 수 있습니다. 예를 들어 참조 필드의 표시 이름을 보내면 엔드포인트는 해당 값에 대한 sys_id를 데이터베이스에 저장합니다. 날짜 및 시간 필드의 경우 이 매개변수가 true이면 현재 사용자의 시간대에 따라 날짜 및 시간 값이 조정됩니다. false인 경우 GMT 시간대를 사용하여 날짜 및 시간 값이 삽입됩니다.

    유효한 값은 다음과 같습니다.

    • true: 입력 값을 표시 값으로 처리하고 데이터베이스에 제대로 저장되도록 조작됩니다.
    • false: 입력 값을 실제 값으로 처리하고 조작 없이 데이터베이스에 저장합니다.

    데이터 유형: 부울

    기본값: false – 실제 값인 데이터 검색(GET 메서드)에서 반환되는 데이터 유형과 일치합니다.

    주:
    암호화된 필드의 값을 설정하려면 이 매개변수를 true로 설정해야 합니다. 이 매개변수가 true로 설정되지 않으면 암호화된 필드에 제출된 값이 저장되지 않습니다. 또한 요청하는 사용자는 요청을 제출하기 전에 적절한 암호화 컨텍스트를 가지고 있어야 합니다. 암호화된 필드는 적절한 암호화 컨텍스트 없는 사용자에 대해 숨겨집니다. 필드 암호화에 대한 자세한 내용은 을 참조하십시오 Column Level Encryption.
    sysparm_query_no_domain 로그인한 사용자가 구성된 도메인으로만 기록 검색을 제한할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우 기록을 제외합니다.
    • true: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우에도 기록을 포함합니다.

    데이터 유형: 부울

    기본값: false

    주:
    sysparm_query_no_domain 매개변수는 시스템 관리자 또는 query_no_domain_table_api 역할을 가진 사용자만 사용할 수 있습니다.
    sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

    유효한 값은 다음과 같습니다.

    • 데스크톱
    • 모바일
    • 모두

    sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

    데이터 유형: 문자열

    표 21. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    이름-값 쌍 지정된 기록에서 업데이트할 각 매개변수의 필드 이름 및 새 값입니다.
    주:
    기록 내의 모든 필드를 업데이트할 수 없습니다. 예를 들어, 프리픽스가 "sys_"인 필드는 일반적으로 자동으로 생성되어 업데이트할 수 없는 시스템 매개변수입니다.

    헤더

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

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

    기본값: application/json

    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json

    X-무응답 본문 기본적으로 응답에는 수정된 기록을 자세히 설명하는 본문 내용이 포함됩니다. 응답 본문을 표시하지 않으려면 이 요청 헤더를 true로 설정합니다.
    표 23. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 24. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    이름 설명
    이름-값 쌍 지정된 기록 내의 모든 매개변수 또는 쿼리 매개변수에 지정된 매개변수의 필드 이름과 값입니다.

    cURL 요청

    인시던트 테이블의 기록을 업데이트합니다.

    curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
    --request PATCH \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
    --user 'username':'password'

    응답에는 업데이트된 레코드에 대한 이름-값 쌍이 포함됩니다.

    {
      "result": {
        "upon_approval": "proceed",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
          "value": "108752c8c611227501d4ab0e392ba97f"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "1",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "1",
        "delivery_plan": "",
        "sys_mod_count": "7",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2017-07-05 05:58:24",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:12:37",
        "parent": "",
        "work_end": "",
        "number": "INC0000050",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "hardware",
        "business_duration": "",
        "incident_state": "2",
        "activity_due": "2016-01-22 16:12:37",
        "correlation_display": "",
        "company": {
          "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
          "value": "31bea3d53790200044e0bfc8bcbe5dec"
        },
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
          "value": "8a5055c9c61122780043563ef53438e3"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
          "value": "5b7c200d0a640069006b3845b5d0fa7c"
        },
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "2",
        "user_input": "",
        "sys_created_on": "2015-11-02 18:05:40",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 21:58:24",
        "short_description": "Can't access Exchange server - is it down?",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "glide.maint",
        "resolved_at": "",
        "assigned_to": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
          "value": "681b365ec0a80164000fb0b05854a0cd"
        },
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
          "value": "281190e3c0a8000b003f593aa3f20ca6"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
          "value": "glide.maint"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "3",
        "comments": ""
      }
    }

    테이블 - POST /now/table/{tableName}

    지정된 테이블에 기록 하나를 삽입합니다. 이 방법에서는 다중 기록 삽입이 지원되지 않습니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}

    기본 URL: /api/now/table/{tableName}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열

    tableName 기록을 저장할 테이블의 이름입니다.

    데이터 유형: 문자열

    표 26. 쿼리 매개변수
    이름 설명
    sysparm_display_value 반환되는 데이터 유형(데이터베이스의 실제 값 또는 필드의 표시 값)을 결정합니다. 표시 값은 데이터베이스의 실제 값과 사용자 또는 시스템 설정 및 기본 설정에 따라 조작됩니다.
    표시 값을 반환하는 경우 반환되는 값은 필드 유형에 따라 다릅니다.
    • 선택 필드: 데이터베이스 값은 숫자일 수 있지만 표시 값은 더 설명적입니다.
    • 날짜 필드: 데이터베이스 값은 UTC 형식이고 표시 값은 사용자의 시간대를 기반으로 합니다.
    • 암호화된 텍스트: 데이터베이스 값은 암호화되지만 표시된 값은 사용자의 암호화 컨텍스트에 따라 암호화되지 않습니다.
    • 참조 필드: 데이터베이스 값은 sys_id이지만 표시 값은 참조된 기록의 표시 필드입니다.

    데이터 유형: 문자열

    유효한 값은 다음과 같습니다.

    • true: 모든 필드에 대한 표시 값을 반환합니다.
    • false: 데이터베이스에서 실제 값을 반환합니다.
    • all: 실제 값과 표시 값을 모두 반환합니다.

    기본값: false

    주:
    이 매개변수를 설정하는 기본 방법은 없습니다. 그러나 표시 값을 지정하면 데이터베이스에서 직접 읽지 않고 다른 필드와 기록을 참조하는 과정이 포함될 수 있으므로 성능 문제가 발생할 수 있습니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오.
    sysparm_exclude_reference_link 참조 필드에 대한 테이블 API 링크를 제외할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • true: 참조 필드에 대한 테이블 API 링크를 제외합니다.
    • false: 참조 필드에 대한 테이블 API 링크를 포함합니다.

    데이터 유형: 부울

    기본값: false

    sysparm_fields 응답에 반환할 쉼표로 구분된 필드 목록입니다.

    데이터 유형: 문자열

    sysparm_input_display_value 표시 값 또는 실제 값을 사용하여 필드 값을 설정할지 여부를 나타내는 플래그입니다. 다양한 유형의 필드에 따라 엔드포인트는 전달된 표시 값을 조작하여 데이터베이스에 적절한 값을 저장할 수 있습니다. 예를 들어 참조 필드의 표시 이름을 보내면 엔드포인트는 해당 값에 대한 sys_id를 데이터베이스에 저장합니다. 날짜 및 시간 필드의 경우 이 매개변수가 true이면 현재 사용자의 시간대에 따라 날짜 및 시간 값이 조정됩니다. false인 경우 GMT 시간대를 사용하여 날짜 및 시간 값이 삽입됩니다.

    유효한 값은 다음과 같습니다.

    • true: 입력 값을 표시 값으로 처리하고 데이터베이스에 제대로 저장되도록 조작됩니다.
    • false: 입력 값을 실제 값으로 처리하고 조작 없이 데이터베이스에 저장합니다.

    데이터 유형: 부울

    기본값: false – 실제 값인 데이터 검색(GET 메서드)에서 반환되는 데이터 유형과 일치합니다.

    주:
    암호화된 필드의 값을 설정하려면 이 매개변수를 true로 설정해야 합니다. 이 매개변수가 true로 설정되지 않으면 암호화된 필드에 제출된 값이 저장되지 않습니다. 또한 요청하는 사용자는 요청을 제출하기 전에 적절한 암호화 컨텍스트를 가지고 있어야 합니다. 암호화된 필드는 적절한 암호화 컨텍스트 없는 사용자에 대해 숨겨집니다. 필드 암호화에 대한 자세한 내용은 을 참조하십시오 Column Level Encryption.
    sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

    유효한 값은 다음과 같습니다.

    • 데스크톱
    • 모바일
    • 모두

    sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

    데이터 유형: 문자열

    표 27. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    이름-값 쌍 지정된 기록에서 정의할 각 매개변수에 대한 필드 이름 및 관련 값입니다.
    주:
    기록 내의 모든 필드를 업데이트할 수 없습니다. 예를 들어, 프리픽스가 "sys_"인 필드는 일반적으로 자동으로 생성되어 업데이트할 수 없는 시스템 매개변수입니다.
    지정되지 않고 시스템에서 자동 생성되지 않은 필드는 연결된 데이터 형식의 null 값으로 설정됩니다.

    헤더

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

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

    기본값: application/json

    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.

    기본값: application/json

    X-무응답 본문 기본적으로 응답에는 새 기록을 자세히 설명하는 본문 내용이 포함됩니다. 응답이 표시되지 않도록 요청에서 이 헤더를 true로 설정합니다.
    표 29. 응답 헤더
    헤더 설명
    위치 생성된 자원의 위치입니다.

    상태 코드

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

    표 30. 상태 코드
    상태 코드 설명
    201 요청이 성공적으로 완료되었음을 나타냅니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    이름 설명
    이름-값 쌍 새로 생성된 기록 내의 모든 매개변수 또는 쿼리 매개변수에 지정된 매개변수의 필드 이름과 값입니다.

    cURL 요청

    인시던트 테이블에 새 기록을 삽입합니다.

    curl "https://instance.servicenow.com/api/now/table/incident" \
    --request POST \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'short_description':'Unable to connect to office wifi','assignment_group':'287ebd7da9fe198100f92cc8d1d2154e','urgency':'2','impact':'2'}" \
    --user 'username':'password'

    응답에는 새 레코드에 대한 이름-값 쌍이 포함됩니다.

    {
      "result": {
        "upon_approval": "proceed",
        "location": "",
        "expected_start": "",
        "reopen_count": "0",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "2",
        "urgency": "2",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "3",
        "delivery_plan": "",
        "sys_mod_count": "0",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:28:24",
        "parent": "",
        "work_end": "",
        "number": "INC0010002",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "inquiry",
        "business_duration": "",
        "incident_state": "1",
        "activity_due": "",
        "correlation_display": "",
        "company": "",
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/287ebd7da9fe198100f92cc8d1d2154e",
          "value": "287ebd7da9fe198100f92cc8d1d2154e"
        },
        "caller_id": "",
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "1",
        "user_input": "",
        "sys_created_on": "2016-01-22 14:28:24",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "0",
        "opened_at": "2016-01-22 14:28:24",
        "short_description": "Unable to connect to office wifi",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "c537bae64f411200adf9f8e18110c76e",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "admin",
        "resolved_at": "",
        "assigned_to": "",
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": "",
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/6816f79cc0a8016401c5a33be04be441",
          "value": "6816f79cc0a8016401c5a33be04be441"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "0",
        "comments": ""
      }
    }

    테이블 - PUT /now/table/{tableName}/{sys_id}

    요청 본문으로 지정된 기록을 업데이트합니다.

    URL 형식

    버전이 지정된 URL: /api/now/{api_version}/table/{tableName}/{sys_id}

    기본 URL: /api/now/table/{tableName}/{sys_id}

    지원되는 요청 매개변수

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

    데이터 유형: 문자열

    sys_id 업데이트할 기록의 고유 식별자입니다.

    데이터 유형: 문자열

    tableName 기록이 위치한 테이블의 이름입니다.

    데이터 유형: 문자열

    표 32. 쿼리 매개변수
    이름 설명
    sysparm_display_value 반환되는 데이터 유형(데이터베이스의 실제 값 또는 필드의 표시 값)을 결정합니다. 표시 값은 데이터베이스의 실제 값과 사용자 또는 시스템 설정 및 기본 설정에 따라 조작됩니다.
    표시 값을 반환하는 경우 반환되는 값은 필드 유형에 따라 다릅니다.
    • 선택 필드: 데이터베이스 값은 숫자일 수 있지만 표시 값은 더 설명적입니다.
    • 날짜 필드: 데이터베이스 값은 UTC 형식이고 표시 값은 사용자의 시간대를 기반으로 합니다.
    • 암호화된 텍스트: 데이터베이스 값은 암호화되지만 표시된 값은 사용자의 암호화 컨텍스트에 따라 암호화되지 않습니다.
    • 참조 필드: 데이터베이스 값은 sys_id이지만 표시 값은 참조된 기록의 표시 필드입니다.

    데이터 유형: 문자열

    유효한 값은 다음과 같습니다.

    • true: 모든 필드에 대한 표시 값을 반환합니다.
    • false: 데이터베이스에서 실제 값을 반환합니다.
    • all: 실제 값과 표시 값을 모두 반환합니다.

    기본값: false

    주:
    이 매개변수를 설정하는 기본 방법은 없습니다. 그러나 표시 값을 지정하면 데이터베이스에서 직접 읽지 않고 다른 필드와 기록을 참조하는 과정이 포함될 수 있으므로 성능 문제가 발생할 수 있습니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오.
    sysparm_exclude_reference_link 참조 필드에 대한 테이블 API 링크를 제외할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • true: 참조 필드에 대한 테이블 API 링크를 제외합니다.
    • false: 참조 필드에 대한 테이블 API 링크를 포함합니다.

    데이터 유형: 부울

    기본값: false

    sysparm_fields 응답에 반환할 쉼표로 구분된 필드 목록입니다.

    데이터 유형: 문자열

    sysparm_input_display_value 표시 값 또는 실제 값을 사용하여 필드 값을 설정할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • true: 입력 값을 표시 값으로 처리하고 데이터베이스에 제대로 저장할 수 있도록 조작됩니다.
    • false: 입력 값을 실제 값으로 처리하고 조작 없이 데이터베이스에 저장합니다.

    데이터 유형: 부울

    기본값: false

    주:
    • 이 매개변수가 true로 설정되면 입력 값, 특히 날짜 값에 주의합니다. 이는 사용자 시간대 기본 설정을 통해 제공되는 것으로 해석되며 UTC 형식으로 변환됩니다.
    • 암호화된 필드의 값을 설정하려면 이 매개변수를 true로 설정해야 합니다. 이 매개변수가 true로 설정되지 않으면 암호화된 필드에 제출된 값이 저장되지 않습니다. 또한 요청하는 사용자는 요청을 제출하기 전에 적절한 암호화 컨텍스트를 가지고 있어야 합니다. 암호화된 필드는 적절한 암호화 컨텍스트 없는 사용자에 대해 숨겨집니다. 표시 값과 실제 값에 대한 자세한 내용은 테이블 API FAQ(KB0534905)를 참조하십시오. 필드 암호화에 대한 자세한 내용은 암호화 지원을 참조하세요.
    sysparm_query_no_domain 로그인한 사용자가 구성된 도메인으로만 기록 검색을 제한할지 여부를 나타내는 플래그입니다.

    유효한 값은 다음과 같습니다.

    • false: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우 기록을 제외합니다.
    • true: 현재 로그인한 사용자가 액세스하도록 구성되지 않은 도메인에 있는 경우에도 기록을 포함합니다.

    데이터 유형: 부울

    기본값: false

    주:
    sysparm_query_no_domain 매개변수는 시스템 관리자 또는 query_no_domain_table_api 역할을 가진 사용자만 사용할 수 있습니다.
    sysparm_view 데이터를 렌더링할 UI 뷰입니다. 응답에서 반환된 필드를 결정합니다.

    유효한 값은 다음과 같습니다.

    • 데스크톱
    • 모바일
    • 모두

    sysparm_fields 매개변수도 지정하는 경우 이 매개변수가 우선 적용됩니다.

    데이터 유형: 문자열

    표 33. 요청 본문 매개변수(XML 또는 JSON)
    이름 설명
    이름-값 쌍 연결된 테이블에서 업데이트할 필드의 이름-값 쌍입니다. 예를 들어, 간단한 설명 파일을 업데이트하려면 --data "{\"short_description\": \"my short desc\" }" \와 유사한 이름-값 쌍을 입력합니다.

    헤더

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

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

    기본값: application/json

    컨텐츠-형식 요청 본문의 데이터 형식입니다. 지원되는 유형은 application/json 또는 application/xml입니다.
    X-무응답 본문 기본적으로 응답에는 수정된 기록을 자세히 설명하는 본문 내용이 포함됩니다. 응답이 표시되지 않도록 요청에서 이 헤더를 true로 설정합니다.
    표 35. 응답 헤더
    헤더 설명
    없음

    상태 코드

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

    표 36. 상태 코드
    상태 코드 설명
    200 성공입니다. 요청이 성공적으로 처리되었습니다.
    400 잘못된 요청입니다. 잘못된 요청 유형 또는 잘못된 형식의 요청이 탐지되었습니다.
    404 찾을 수 없습니다. 요청한 항목을 찾을 수 없습니다.

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

    이름 설명
    이름-값 쌍 변경 요청에 대한 관련 값이 있는 모든 필드(수정되었을 뿐만 아니라)입니다.

    cURL 요청

    인시던트 테이블의 기록을 업데이트합니다.

    curl "https://instance.servicenow.com/api/now/table/incident/ef43c6d40a0a0b5700c77f9bf387afe3" \
    --request PUT \
    --header "Accept:application/json" \
    --header "Content-Type:application/json" \
    --data "{'assigned_to':'681b365ec0a80164000fb0b05854a0cd','urgency':'1','comments':'Elevating urgency, this is a blocking issue'}" \
    --user 'username':'password'

    응답에는 업데이트된 레코드에 대한 이름-값 쌍이 포함됩니다.

    {
      "result": {
        "upon_approval": "proceed",
        "location": {
          "link": "https://instance.servicenow.com/api/now/table/cmn_location/108752c8c611227501d4ab0e392ba97f",
          "value": "108752c8c611227501d4ab0e392ba97f"
        },
        "expected_start": "",
        "reopen_count": "",
        "close_notes": "",
        "additional_assignee_list": "",
        "impact": "1",
        "urgency": "1",
        "correlation_id": "",
        "sys_tags": "",
        "sys_domain": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/global",
          "value": "global"
        },
        "description": "",
        "group_list": "",
        "priority": "1",
        "delivery_plan": "",
        "sys_mod_count": "7",
        "work_notes_list": "",
        "business_service": "",
        "follow_up": "",
        "closed_at": "",
        "sla_due": "2017-07-05 05:58:24",
        "delivery_task": "",
        "sys_updated_on": "2016-01-22 14:12:37",
        "parent": "",
        "work_end": "",
        "number": "INC0000050",
        "closed_by": "",
        "work_start": "",
        "calendar_stc": "",
        "category": "hardware",
        "business_duration": "",
        "incident_state": "2",
        "activity_due": "2016-01-22 16:12:37",
        "correlation_display": "",
        "company": {
          "link": "https://instance.servicenow.com/api/now/table/core_company/31bea3d53790200044e0bfc8bcbe5dec",
          "value": "31bea3d53790200044e0bfc8bcbe5dec"
        },
        "active": "true",
        "due_date": "",
        "assignment_group": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user_group/8a5055c9c61122780043563ef53438e3",
          "value": "8a5055c9c61122780043563ef53438e3"
        },
        "caller_id": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/5b7c200d0a640069006b3845b5d0fa7c",
          "value": "5b7c200d0a640069006b3845b5d0fa7c"
        },
        "knowledge": "false",
        "made_sla": "true",
        "comments_and_work_notes": "",
        "parent_incident": "",
        "state": "2",
        "user_input": "",
        "sys_created_on": "2015-11-02 18:05:40",
        "approval_set": "",
        "reassignment_count": "0",
        "rfc": "",
        "child_incidents": "",
        "opened_at": "2015-11-02 21:58:24",
        "short_description": "Can't access Exchange server - is it down?",
        "order": "",
        "sys_updated_by": "admin",
        "resolved_by": "",
        "notify": "1",
        "upon_reject": "cancel",
        "approval_history": "",
        "problem_id": "",
        "work_notes": "",
        "calendar_duration": "",
        "close_code": "",
        "sys_id": "ef43c6d40a0a0b5700c77f9bf387afe3",
        "approval": "not requested",
        "caused_by": "",
        "severity": "3",
        "sys_created_by": "glide.maint",
        "resolved_at": "",
        "assigned_to": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/681b365ec0a80164000fb0b05854a0cd",
          "value": "681b365ec0a80164000fb0b05854a0cd"
        },
        "business_stc": "",
        "wf_activity": "",
        "sys_domain_path": "/",
        "cmdb_ci": {
          "link": "https://instance.servicenow.com/api/now/table/cmdb_ci/281190e3c0a8000b003f593aa3f20ca6",
          "value": "281190e3c0a8000b003f593aa3f20ca6"
        },
        "opened_by": {
          "link": "https://instance.servicenow.com/api/now/table/sys_user/glide.maint",
          "value": "glide.maint"
        },
        "subcategory": "",
        "rejection_goto": "",
        "sys_class_name": "incident",
        "watch_list": "",
        "time_worked": "",
        "contact_type": "phone",
        "escalation": "3",
        "comments": ""
      }
    }