| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\n$id\n\n | \n\nString or Number\n\n | \n\nRequired. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).Format: `Now.ID['String' or Number]`\n\n |
| \n\nname\n\n | \n\nString\n\n | \n\nRequired. The name of the API, which is used in the API documentation.\n\n |
| \n\nserviceId\n\n | \n\nString\n\n | \n\nRequired. The API identifier used to distinguish this API in URI paths. It must be unique within the API namespace.\n\n |
| \n\nactive\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the API can serve requests.Valid values:\n\n- true: The API can serve requests.\n- false: The API can't serve requests.\n\nDefault: true\n\n |
| \n\nshortDescription\n\n | \n\nString\n\n | \n\nA brief description of the API, which is used in the API documentation.\n\n |
| \n\nconsumes\n\n | \n\nString\n\n | \n\nA list of media types that resources of the API can consume.Default: application/json,application/xml,text/xml\n\n |
| \n\ndocLink\n\n | \n\nString\n\n | \n\nA URL that links to static documentation about the API.\n\n |
| \n\nenforceAcl\n\n | \n\nArray\n\n | \n\nA list of variable identifiers of ACL objects or sys\\_ids of ACLs to enforce when accessing resources \\[sys\\_security\\_acl\\]. For more information, see [Access Control List API - ServiceNow Fluent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/acl-api-now-ts.md).To not enforce ACLs, set this property to an empty array \\(`[]`\\).\n\nDefault: Scripted REST External Default\n\n |
| \n\nproduces\n\n | \n\nString\n\n | \n\nA list of media types that resources of the API can produce.Default: application/json,application/xml,text/xml\n\n |
| \n\nroutes\n\n | \n\nArray\n\n | \n\nThe resources \\[sys\\_ws\\_operation\\] for the API. For more information, see [routes object](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/scripted-rest-api-api-now-ts.md).\n\n |
| \n\npolicy\n\n | \n\nString\n\n | \n\nThe policy for how application files are protected when downloaded or installed.Valid values:\n\n- read: Files are viewable only.\n- protected: Users with password permissions can edit the files.\n\n |
| \n\nversions\n\n | \n\nArray\n\n | \n\nA list of versions \\[sys\\_ws\\_version\\] for the API. For more information, see [versions object](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/scripted-rest-api-api-now-ts.md).Specifying versions allows you to manage different versions of an API and their statuses, such as whether they are active, the default version, or deprecated.\n\n |
| \n\n$meta\n\n | \n\nObject\n\n | \n\nMetadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.\n\n```javascript\n$meta: {\n installMethod: 'String'\n}\n```\n\nValid values for installMethod:\n\n- demo: Outputs the application metadata to the `metadata/unload.demo` directory to be installed with the application when the **Load demo data** option is selected.\n- first install: Outputs the application metadata to the `metadata/unload` directory to be installed only the first time an application is installed on an instance.\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\n$id\n\n | \n\nString or Number\n\n | \n\nRequired. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).Format: `Now.ID['String' or Number]`\n\n |
| \n\nname\n\n | \n\nString\n\n | \n\nThe name of the API resource, which is used in the API documentation.Default: the value of the path property\n\n |
| \n\nscript\n\n | \n\nScript\n\n | \n\nRequired. The custom script defines how the operation parses and responds to requests. This property supports a function from a JavaScript module, a reference to another file in the application that contains a script, or inline JavaScript.Format:\n\n- For functions, use the name of a function, function expression, or default function exported from a JavaScript module and import it into the `.now.ts` file. For information about JavaScript modules, see [JavaScript modules and third-party libraries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/javascript-modules-third-party-libraries.md).\n- To use text content from another file, refer to a file in the application using the following format: `Now.include('path/to/file')`. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).\n- To provide an inline script, use string literals or template literals for multiple lines of code: `'Script' or `Script``.\n\n |
| \n\nparameters\n\n | \n\nArray\n\n | \n\nA list of query parameters \\[sys\\_ws\\_query\\_parameter\\] for the route. For more information, see [parameters and headers objects](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/scripted-rest-api-api-now-ts.md).\n\n |
| \n\nheaders\n\n | \n\nArray\n\n | \n\nA list of headers \\[sys\\_ws\\_header\\] for the route. For more information, see [parameters and headers objects](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/scripted-rest-api-api-now-ts.md).\n\n |
| \n\nactive\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the resource is used.Valid values:\n\n- true: The resource is used.\n- false: The resource isn't used.\n\nDefault: true\n\n |
| \n\npath\n\n | \n\nString\n\n | \n\nThe path of the resource relative to the base API path. The relative URI can contain path parameters such as `'/abc/{id}'`.Default: /\n\n |
| \n\nshortDescription\n\n | \n\nString\n\n | \n\nA brief description of the resource, which is used in the API documentation.\n\n |
| \n\nconsumes\n\n | \n\nString\n\n | \n\nA list of media types that the resource can consume.This property can be overridden with the PUT, PATCH, or POST methods.\n\nDefault: The value of the consumes property in the RestApi object\n\n |
| \n\nenforceAcl\n\n | \n\nArray\n\n | \n\nA list of variable identifiers of ACL objects or sys\\_ids of ACLs to enforce when accessing resources \\[sys\\_security\\_acl\\]. For more information, see [Access Control List API - ServiceNow Fluent](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/acl-api-now-ts.md).To not enforce ACLs, set this property to an empty array \\(`[]`\\).\n\nDefault: Scripted REST External Default\n\n |
| \n\nproduces\n\n | \n\nString\n\n | \n\nA list of media types that the resource can produce.Default: The value of the produces property in the RestApi object\n\n |
| \n\nrequestExample\n\n | \n\nString\n\n | \n\nA valid sample request body payload for the resource, which is used in the API documentation.\n\n |
| \n\nmethod\n\n | \n\nString\n\n | \n\nThe HTTP method that the resource implements.Valid values: GET, POST, PUT, PATCH, DELETE\n\nDefault: GET\n\n |
| \n\nauthentication\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether users must be authenticated to access the resource.Valid values:\n\n- true: Users must be authenticated to access the resource.\n- false: Authentication isn't required to access the resource.\n\nDefault: true\n\n |
| \n\nauthorization\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether ACLs are enforced when accessing the resource.Valid values:\n\n- true: ACLs are enforced when accessing the resource.\n- false: ACLs aren't enforced when accessing the resource.\n\nDefault: true\n\n |
| \n\ninternalRole\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the route requires the snc\\_internal role.This property is supported only if the Explicit Roles plugin \\(com.glide.explicit\\_roles\\) is enabled.\n\nValid values:\n\n- true: The route requires the snc\\_internal role.\n- false: The route doesn't require the snc\\_internal role.\n\nDefault: true\n\n |
| \n\npolicy\n\n | \n\nString\n\n | \n\nThe policy for how application files are protected when downloaded or installed.Valid values:\n\n- read: Files are viewable only.\n- protected: Users with password permissions can edit the files.\n\n |
| \n\nversion\n\n | \n\nNumber\n\n | \n\nThe version of the API.This property is required if the versions property is used in the RestApi object.\n\nThe version specified with this property is used to automatically generate a URI with a version, such as `/api/management/v1/table/{tableName}`. Version numbers identify the endpoint version that a URI accesses. By specifying a version number, you can test and deploy changes without impacting existing integrations.\n\n |
| \n\n$meta\n\n | \n\nObject\n\n | \n\nMetadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.\n\n```javascript\n$meta: {\n installMethod: 'String'\n}\n```\n\nValid values for installMethod:\n\n- demo: Outputs the application metadata to the `metadata/unload.demo` directory to be installed with the application when the **Load demo data** option is selected.\n- first install: Outputs the application metadata to the `metadata/unload` directory to be installed only the first time an application is installed on an instance.\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\n$id\n\n | \n\nString or Number\n\n | \n\nRequired. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).Format: `Now.ID['String' or Number]`\n\n |
| \n\nname\n\n | \n\nString\n\n | \n\nRequired. The name of the parameter or header, which is used in the API documentation.\n\n |
| \n\nrequired\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the parameter or header is required.Valid values:\n\n- true: The parameter or header is required.\n- false: The parameter or header isn't required.\n\nDefault: false\n\n |
| \n\nexampleValue\n\n | \n\nString\n\n | \n\nAn example of a valid value for the parameter or header, which is used in the API documentation.\n\n |
| \n\nshortDescription\n\n | \n\nString\n\n | \n\nA brief description of the parameter or header, which is used in the API documentation.\n\n |
| \n\n$meta\n\n | \n\nObject\n\n | \n\nMetadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.\n\n```javascript\n$meta: {\n installMethod: 'String'\n}\n```\n\nValid values for installMethod:\n\n- demo: Outputs the application metadata to the `metadata/unload.demo` directory to be installed with the application when the **Load demo data** option is selected.\n- first install: Outputs the application metadata to the `metadata/unload` directory to be installed only the first time an application is installed on an instance.\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\n$id\n\n | \n\nString or Number\n\n | \n\nRequired. A unique ID for the metadata object. When you build the application, this ID is hashed into a unique sys\\_id. For more information, see [ServiceNow Fluent language constructs](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/application-development/servicenow-sdk/fluent-constructs.md).Format: `Now.ID['String' or Number]`\n\n |
| \n\nversion\n\n | \n\nNumber\n\n | \n\nRequired. A version of the REST API.\n\n |
| \n\nactive\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the version of the REST API can serve requests.Valid values:\n\n- true: The version of the API can serve requests.\n- false: The version of the API can't serve requests.\n\nDefault: true\n\n |
| \n\ndeprecated\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the version of the REST API is deprecated. Resources belonging to deprecated versions can serve requests, but are identified as deprecated in documentation.Valid values:\n\n- true: The version of the API is identified as deprecated.\n- false: The version of the API isn't identified as deprecated.\n\nDefault: false\n\n |
| \n\nshortDescription\n\n | \n\nString\n\n | \n\nA brief description of the version of the REST API, which appears in the API documentation.\n\n |
| \n\nisDefault\n\n | \n\nBoolean\n\n | \n\nFlag that indicates whether the version of the REST API is the default version. Clients can access the default version using either the versioned or non-versioned URI path.Valid values:\n\n- true: The version of the API is the default version.\n- false: The version of the API isn't the default version.\n\nDefault: false\n\n |
| \n\n$meta\n\n | \n\nObject\n\n | \n\nMetadata for the application metadata.With the installMethod property, you can map the application metadata to an output directory that loads only in specific circumstances.\n\n```javascript\n$meta: {\n installMethod: 'String'\n}\n```\n\nValid values for installMethod:\n\n- demo: Outputs the application metadata to the `metadata/unload.demo` directory to be installed with the application when the **Load demo data** option is selected.\n- first install: Outputs the application metadata to the `metadata/unload` directory to be installed only the first time an application is installed on an instance.\n\n |