Skip to content
Mobile SDK - iOS › Mobile SDK API reference › API reference › API implementation and reference
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

NowAPIService class- iOS

The NowAPIService class provides functions that enable you to perform requests to a specified ServiceNow REST API.

NameTypeDescription
configurationNowServiceConfigurationService configuration to associate with the protocol.

Parent Topic:Mobile SDK - iOS

NowAPIService - data(for endpoint: NowAPIEndpoint, queryItems: [String: String], httpHeaders: [String: String], body: Data, completion: @escaping (Result<DataResponse, NowDataError>)

Requests data from the specified ServiceNow REST API and then executes the completion handler.

NameTypeDescription
for endpointNowAPIEndpointObject containing the ServiceNow REST API endpoint to access, including the HTTP method, relative path to the endpoint, path parameters, and whether authentication is required.
queryItemsArrayOptional. Query parameters for the endpoint as key/value pairs.Default: nil
httpHeadersArrayOptional. Request HTTP headers required by the endpoint as key/value pairs. Default: nil
bodyStringOptional. Request body parameters.Default: nil
completion@escaping \(Result<DataResponse, NowDataError>\)

Completion handler to execute after the REST API call completes. Return values for the completion handler:

  • Success: DataResponse that contains the returned data from the REST API call.
  • Failure: NowDataError

  • accessToken(AccessTokenProviderError)

    -   **AccessTokenProviderError**: The access token provider's error code or message.
    -   accessTokenRetrievalFailed
    -   userSessionError\(\_ error: Error\)

    Thrown when there is an error in the access token.

  • attachmentValidation

Thrown when an attachment fails validation.

  • badResponse(statusCode: HTTPStatusCode)

    -   **HTTPStatusCode**: Status code received from the instance.

    Thrown when a request returns an unexpected response

  • cannotDecodeModel(DecodingError)

    -   **DecodingError**: Decoding error detected.

    Thrown when a Codable model cannot be decoded from JSON.

  • cannotDecodeProperty(type: Any, from: String)

    -   **type**: Wrapped type to decode from a string.
-   **from**: String to decode to the specified type.

    Thrown when a string-wrapped value cannot be decoded from JSON.

  • cannotEncodeModel(EncodingError)

    -   **EncodingError**: Encoding error detected.

    Thrown when a Codable model cannot be encoded to JSON.

  • cannotParseResponse

Thrown when a response from the instance cannot be parsed into its expected format.

  • invalidURL

Thrown when a URL cannot be formed. For example, if the string contains characters that are illegal in a URL or is an empty string.

  • missingAttachmentMetadata

Thrown when the attachment metadata header is missing.

  • missingServiceConfiguration

Thrown when an expected service configuration is missing.

  • missingSysID

Thrown when an expected sys_id parameter is missing.

  • network(NetworkServiceError)
    -   genericError\(String\)
-   operationCanceled
-   service​Disabled
-   serverError\(Error\)
-   systemError\(Error\)

    Thrown when a network service encountered an error.

TypeDescription
None 

The following code example shows how to call this function.

struct Endpoint: NowAPIEndpoint {
  let httpMethod: HTTPMethod
  let relativePath: String
  let requiresAuthentication: Bool
}

/// HTTP request method
public enum HTTPMethod: CaseIterable {
    case options, get, head, post, put, patch, delete, trace, connect
}
let relativePath = “/api/now/account”
let endPoint = Endpoint(httpMethod: HTTPMethod.get, relativePath: relativePath, requiresAuthentication: true)

apiService.data(for: endPoint, queryItems: [“name”: “abel”], httpHeaders: httpHeaders, body: body.data(using: .utf8)) { [weak self] (result) in
  switch result {
    case .success(let response):
    // Data request successful
    case .failure(let error):
    // Data request failed, return NowDataError
    // .failure(error)
  }
}

NowAPIService - data(for endpoint: NowAPIEndpoint, queryItems: [String: String], httpHeaders: [String: String], body: Data) async throws

Requests data from the specified ServiceNow REST API.

NameTypeDescription
for endpointNowAPIEndpointObject containing the ServiceNow REST API endpoint to access, including the HTTP method, relative path to the endpoint, path parameters, and whether authentication is required.
queryItemsArrayOptional. Query parameters for the endpoint as key/value pairs.Default: nil
httpHeadersArrayOptional. Request HTTP headers required by the endpoint as key/value pairs. Default: nil
bodyStringOptional. Request body parameters.Default: nil
TypeDescription
DataResponseReturned when the method is successful. Data from the REST API call.
NowDataError

Thrown when the method fails. - accessToken(AccessTokenProviderError)

  • AccessTokenProviderError: The access token provider's error code or message. - accessTokenRetrievalFailed - userSessionError(_ error: Error) Thrown when there is an error in the access token.

  • attachmentValidation

Thrown when an attachment fails validation.

  • badResponse(statusCode: HTTPStatusCode)

  • HTTPStatusCode: Status code received from the instance. Thrown when a request returns an unexpected response

  • cannotDecodeModel(DecodingError)

  • DecodingError: Decoding error detected. Thrown when a Codable model cannot be decoded from JSON.

  • cannotDecodeProperty(type: Any, from: String)

  • type: Wrapped type to decode from a string.

  • from: String to decode to the specified type. Thrown when a string-wrapped value cannot be decoded from JSON.

  • cannotEncodeModel(EncodingError)

  • EncodingError: Encoding error detected. Thrown when a Codable model cannot be encoded to JSON.

  • cannotParseResponse

Thrown when a response from the instance cannot be parsed into its expected format.

  • invalidURL

Thrown when a URL cannot be formed. For example, if the string contains characters that are illegal in a URL or is an empty string.

  • missingAttachmentMetadata

Thrown when the attachment metadata header is missing.

  • missingServiceConfiguration

Thrown when an expected service configuration is missing.

  • missingSysID

Thrown when an expected sys_id parameter is missing.

  • network(NetworkServiceError)

  • genericError(String)

  • operationCanceled
  • service​Disabled
  • serverError(Error)
  • systemError(Error) Thrown when a network service encountered an error.

The following code examples shows how to call this method.

do {
    let dataResponse = try await apiService.data(for: endpoint, queryItems: queryItems, httpHeaders: httpHeaders, body: body)
    // Data request successful
} catch {
    // Data request failed, NowDataError thrown
}

NowAPIService - data(for endpoint: NowAPIEndpoint, queryItems: [String: String]? = nil, httpHeaders: [String: String]? = nil, body: Data? = nil)

Requests data from the specified ServiceNow REST API.

Note: This method has been deprecated. You should use the async/await implementation of the method instead.

NameTypeDescription
for endpointNowAPIEndpointObject containing the ServiceNow REST API endpoint to access, including the HTTP method, relative path to the endpoint, path parameters, and whether authentication is required.
queryItemsArrayOptional. Query parameters for the endpoint as key/value pairs.Default: nil
httpHeadersArrayOptional. Request HTTP headers required by the endpoint as key/value pairs.Default: nil
bodyDataOptional. Request body parameters. Default: nil
TypeDescription
AnyPublisher<DataResponse, NowDataError>

Success: Data returned by the REST API.Failure: NowDataError

  • accessToken(AccessTokenProviderError)

  • AccessTokenProviderError: The access token provider's error code or message. - accessTokenRetrievalFailed - userSessionError(_ error: Error) Thrown when there is an error in the access token.

  • attachmentValidation

Thrown when an attachment fails validation.

  • badResponse(statusCode: HTTPStatusCode)

  • HTTPStatusCode: Status code received from the instance. Thrown when a request returns an unexpected response

  • cannotDecodeModel(DecodingError)

  • DecodingError: Decoding error detected. Thrown when a Codable model cannot be decoded from JSON.

  • cannotDecodeProperty(type: Any, from: String)

  • type: Wrapped type to decode from a string.

  • from: String to decode to the specified type. Thrown when a string-wrapped value cannot be decoded from JSON.

  • cannotEncodeModel(EncodingError)

  • EncodingError: Encoding error detected. Thrown when a Codable model cannot be encoded to JSON.

  • cannotParseResponse

Thrown when a response from the instance cannot be parsed into its expected format.

  • invalidURL

Thrown when a URL cannot be formed. For example, if the string contains characters that are illegal in a URL or is an empty string.

  • missingAttachmentMetadata

Thrown when the attachment metadata header is missing.

  • missingServiceConfiguration

Thrown when an expected service configuration is missing.

  • missingSysID

Thrown when an expected sys_id parameter is missing.

  • network(NetworkServiceError)

  • genericError(String)

  • operationCanceled
  • service​Disabled
  • serverError(Error)
  • systemError(Error) Thrown when a network service encountered an error.

The following code example shows how to call this function.

struct Endpoint: NowAPIEndpoint {
    let httpMethod: HTTPMethod
    let relativePath: String
    let requiresAuthentication: Bool
}

/// HTTP request method
public enum HTTPMethod: CaseIterable {
    case options, get, head, post, put, patch, delete, trace, connect
}
let relativePath = "/api/now/account"
let endPoint = Endpoint(httpMethod: HTTPMethod.get, relativePath: relativePath, requiresAuthentication: true)

// Using Combine
apiService.data(for: Endpoint(httpMethod: httpMethod, relativePath: endpointPath, requiresAuthentication: requiresAuthentication), queryItems: queryItems, httpHeaders: httpHeaders, body: body.data(using: .utf8))
  .receive(on: DispatchQueue.main)
  .sink { [weak self] (comp) in
    if case let .failure(error) = comp {
      // Data request failed, return NowDataError
    }
  } receiveValue: { [weak self] (response) in
    // Data request successful
    self?.publish(data: response.data)
  }
  .store(in: &self.subscriptions)
}