@servicenow/sdk - v4.4.1
Preparing search index...
@servicenow/sdk/core
sys_rest_message
Variable sys_rest_message
Const
sys_rest_message
:
{
extends
:
"sys_metadata"
;
name
:
"sys_rest_message"
;
schema
:
{
access
:
Typed
<
"public"
|
"package_private"
,
{
active
:
true
;
choices
:
{
package_private
:
{
inactive
:
false
;
label
:
"This application scope only"
;
language
:
"en"
;
}
;
public
:
{
inactive
:
false
;
label
:
"All application scopes"
;
language
:
"en"
;
}
;
}
;
default
:
"package_private"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Accessible from"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
authentication_type
:
Typed
<
"basic"
|
"no_authentication"
|
"basic_simple"
|
"oauth2"
,
{
active
:
true
;
choices
:
{
basic
:
{
inactive
:
false
;
label
:
"Basic"
;
language
:
"en"
;
sequence
:
10
;
}
;
basic_simple
:
{
inactive
:
false
;
label
:
"Basic (simple)"
;
language
:
"en"
;
sequence
:
20
;
}
;
no_authentication
:
{
inactive
:
false
;
label
:
"No authentication"
;
language
:
"en"
;
sequence
:
5
;
}
;
oauth2
:
{
inactive
:
false
;
label
:
"OAuth 2.0"
;
language
:
"en"
;
sequence
:
30
;
}
;
}
;
default
:
"no_authentication"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Authentication type"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
basic_auth_password
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"password2"
;
label
:
"Basic authentication password"
;
mandatory
:
false
;
maxLength
:
255
;
read_only
:
false
;
}
,
>
;
basic_auth_profile
:
Typed
<
|
string
|
Record
<
"sys_auth_profile_basic"
>
|
ExplicitKey
<
"sys_auth_profile_basic"
>
|
TableBrand
<
"sys_auth_profile_basic"
>
,
{
active
:
true
;
label
:
"Basic auth profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"sys_auth_profile_basic"
;
}
,
>
;
basic_auth_user
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Basic authentication user ID"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
description
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Description"
;
mandatory
:
false
;
maxLength
:
1000
;
read_only
:
false
;
}
,
>
;
name
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Name"
;
mandatory
:
true
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
oauth2_profile
:
Typed
<
|
string
|
Record
<
"oauth_entity_profile"
>
|
ExplicitKey
<
"oauth_entity_profile"
>
|
TableBrand
<
"oauth_entity_profile"
>
,
{
active
:
true
;
label
:
"OAuth profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"oauth_entity_profile"
;
}
,
>
;
protocol_name
:
Typed
<
|
string
|
Record
<
"sys_protocol_profile"
>
|
ExplicitKey
<
"sys_protocol_profile"
>
|
TableBrand
<
"sys_protocol_profile"
>
,
{
active
:
true
;
label
:
"Mutual authentication profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"sys_protocol_profile"
;
}
,
>
;
rest_endpoint
:
Typed
<
string
,
{
active
:
true
;
label
:
"Endpoint"
;
mandatory
:
true
;
maxLength
:
200
;
read_only
:
false
;
}
,
>
;
use_basic_auth
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Use basic authentication"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
use_mutual_auth
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Use mutual authentication"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
}
;
}
= ...
Type Declaration
Readonly
extends
:
"sys_metadata"
Readonly
name
:
"sys_rest_message"
Readonly
schema
:
{
access
:
Typed
<
"public"
|
"package_private"
,
{
active
:
true
;
choices
:
{
package_private
:
{
inactive
:
false
;
label
:
"This application scope only"
;
language
:
"en"
;
}
;
public
:
{
inactive
:
false
;
label
:
"All application scopes"
;
language
:
"en"
;
}
;
}
;
default
:
"package_private"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Accessible from"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
authentication_type
:
Typed
<
"basic"
|
"no_authentication"
|
"basic_simple"
|
"oauth2"
,
{
active
:
true
;
choices
:
{
basic
:
{
inactive
:
false
;
label
:
"Basic"
;
language
:
"en"
;
sequence
:
10
;
}
;
basic_simple
:
{
inactive
:
false
;
label
:
"Basic (simple)"
;
language
:
"en"
;
sequence
:
20
;
}
;
no_authentication
:
{
inactive
:
false
;
label
:
"No authentication"
;
language
:
"en"
;
sequence
:
5
;
}
;
oauth2
:
{
inactive
:
false
;
label
:
"OAuth 2.0"
;
language
:
"en"
;
sequence
:
30
;
}
;
}
;
default
:
"no_authentication"
;
dropdown
:
"dropdown_without_none"
;
label
:
"Authentication type"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
basic_auth_password
:
Typed
<
string
|
number
,
{
active
:
true
;
column_type
:
"password2"
;
label
:
"Basic authentication password"
;
mandatory
:
false
;
maxLength
:
255
;
read_only
:
false
;
}
,
>
;
basic_auth_profile
:
Typed
<
|
string
|
Record
<
"sys_auth_profile_basic"
>
|
ExplicitKey
<
"sys_auth_profile_basic"
>
|
TableBrand
<
"sys_auth_profile_basic"
>
,
{
active
:
true
;
label
:
"Basic auth profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"sys_auth_profile_basic"
;
}
,
>
;
basic_auth_user
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Basic authentication user ID"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
description
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Description"
;
mandatory
:
false
;
maxLength
:
1000
;
read_only
:
false
;
}
,
>
;
name
:
Typed
<
string
,
{
active
:
true
;
dropdown
:
"none"
;
label
:
"Name"
;
mandatory
:
true
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
oauth2_profile
:
Typed
<
|
string
|
Record
<
"oauth_entity_profile"
>
|
ExplicitKey
<
"oauth_entity_profile"
>
|
TableBrand
<
"oauth_entity_profile"
>
,
{
active
:
true
;
label
:
"OAuth profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"oauth_entity_profile"
;
}
,
>
;
protocol_name
:
Typed
<
|
string
|
Record
<
"sys_protocol_profile"
>
|
ExplicitKey
<
"sys_protocol_profile"
>
|
TableBrand
<
"sys_protocol_profile"
>
,
{
active
:
true
;
label
:
"Mutual authentication profile"
;
mandatory
:
false
;
maxLength
:
32
;
read_only
:
false
;
referenceTable
:
"sys_protocol_profile"
;
}
,
>
;
rest_endpoint
:
Typed
<
string
,
{
active
:
true
;
label
:
"Endpoint"
;
mandatory
:
true
;
maxLength
:
200
;
read_only
:
false
;
}
,
>
;
use_basic_auth
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Use basic authentication"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
use_mutual_auth
:
Typed
<
boolean
,
{
active
:
true
;
label
:
"Use mutual authentication"
;
mandatory
:
false
;
maxLength
:
40
;
read_only
:
false
;
}
,
>
;
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
@servicenow/sdk - v4.4.1
Loading...