API Name definition

API Name. Set Auth Token for a given user • Description: Set the Auth Token, which is also referred to as digital token, for a specified user account. The current user who is logging in to REST service must have the Administrator permission to use this API.
API Name. Get agent by agent ID • Description: Filter out agents by the agent ID. • Request type: GET • API path: /api/v1/agent/agentId/agentId • Sample usage: http://<server>:<port>/api/v1/agent/agentId/1 • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Agent — Get all active agents‌ • API Name: Get all active agents • Description: Filter out all active agents. • Request type: GET • API path: /api/v1/agent/active • Sample usage: http://<server>:<port>/api/v1/agent/active • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. error String Error code if some exception occurs; otherwise this field is not shown. Agent — Get all agents‌ • API Name: Get all agents • Description: Get all agents. • Request type: GET • API path: /api/v1/agent/allAgents • Sample usage: http://<server>:<port>/api/v1/agent/allAgents • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Agent — Get all inactive agents‌ • API Name: Get all inactive agents • Description: Filter out all inactive agents. • Request type: GET • API path: /api/v1/agent/inactive • Sample usage: http://<server>:<port>/api/v1/agent/inactive • Header: Field Type Description Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data form...
API Name. Disconnect SSE • Description: Disconnect all the active Server-Sent Events (SSE) subscriptions. • Request type: GET • API path: /api/v1/subscription/disconnect/all/ • Sample usage: http://<server>:<port>/api/v1/subscription/disconnect/all/ Access- Token String The token is retrieved after successfully logging in to the Management Server. Accept String Specifies the response data format which can be either application/json or application/xml. The default value is application/json. • Returned value: Field Type Description status String The response status. data String Either the response data format (JSON/XML) or exception message. error String Error code if some exception occurs; otherwise this field is not shown. Subscribe alarm — List SSE‌ • API Name: List SSE • Description: Filter out all the active SSE subscriptions. • Request type: GET • API path: /api/v1/subscription/list/ • Sample usage: http://<server>:<port>/api/v1/subscription/list • Header:

Examples of API Name in a sentence

  • Each pair in the field map is structured as Salesforce API Name: Database Column Name.

  • Security — Delete Auth Token for a given user‌ • API Name: Delete Auth Token for a given user • Description: Delete the Auth Token, which is also referred to as digital token, for a specified user account.

  • Alarm — Clear alarm by alarm ID‌ • API Name: Clear alarm by alarm ID • Description: Clear an alarm by its ID.

  • Security — Set Auth Token for current user‌ • API Name: Set Auth Token for the current user • Description: Set the Auth Token, which is also referred to as digital token, for the current login user.

  • Alarm — Get alarm by alarm ID‌ • API Name: Get alarm by alarm ID • Description: Filter out alarms by alarm ID.

  • Security — Logout‌ • API Name: Logout • Description: Expire an access token.

  • Alarm — Get current alarms‌ • API Name: Get current alarms • Description: Filter out current alarms.

  • Security‌ The Security related APIs include the following: • Security — Login • Security — Logout • Security — Set Auth Token for a given user • Security — Delete Auth Token for a given user • Security — Set Auth Token for current user • Security — Delete Auth Token for current user Security — Login‌‌ • API Name: Login • Description: Obtain an access token through user credentials (namely username and pwd in the Parameter: table) or a digital token (namely authToken in the Parameter: table).

  • Alarm — Get history alarms‌ • API Name: Get history alarms • Description: Filter out all history alarms.

  • TopologyType — Get all instances of a type‌ • API Name: Get all instances of a type • Description: Get all instances of a type.


More Definitions of API Name

API Name. Get agent by agent ID • Description: Filter out agents by the agent ID. • Request type: GET • API path: /api/v1/agent/agentId/agentId • Sample usage: http://<server>:<port>/api/v1/agentId/1 • Header:
API Name. [insert API name]

Related to API Name

  • User Name means any user name allocated to the Customer for access to the Services;

  • Product name means the name of the commercial feed which identifies it as to kind, class or specific use.

  • s Name Property Address: _________________________________________________________

  • business name or "trade name" means the name of a licensed business as used by the licensee on signs and advertising.

  • Company Name Address: Attention: Tel: Fax: Email: If sent to Cornell: For all correspondence except payments - Center for Technology Licensing at Cornell University Attention: Executive Director 000 Xxxx Xxxx Xxxx, Xxxxx 000 Xxxxxx, XX 00000 FAX: 000-000-0000 TEL: 000-000-0000 EMAIL: xxx-xxxxxxxxx@xxxxxxx.xxx For all payments - If sent by mail: Center for Technology Licensing at Cornell University XX Xxx 0000 Xxxxxx, XX 00000-0000 If remitted by electronic payments via ACH or Fed Wire: Receiving bank name: Xxxxxxxx Trust Co. Bank account no.: 0111000065 Bank routing (ABA) no.: 000000000 SWIFT code: Bank account name: XXXXXX00 Cornell University Bank ACH format code: Not required Bank address: X.X. 000, Xxxxxx, XX 00000 Additional information: Reference D-5062 Agreement No.: <to be filled> An email copy of the transaction receipt shall be sent to xxx-xxxxxxxxx@xxxxxxx.xxx. Licensee is responsible for all bank charges of wire transfer of funds for payments. The bank charges shall not be deducted from the total amount due to Cornell.

  • By: Name Title: Date: ---------------------------------------------------

  • Brand name or “trade name” means a brand name or a trade name, whether registered or not, that is to say, a name or a mark, such as symbol, monogram, logo, label, signature, or invented word or writing which is used in relation to such specified services for the purpose of indicating, or so as to indicate a connection in the course of trade between such specified services and some person using such name or mark with or without any indication of the identity of that person;

  • Print Name Signature: Date:

  • Project Name refers to the project title as stated in the legal agreement (Financing Agreement) between the World Bank and the Government. It should not be confused with the name of the UN Agency’s project or program financed from other sources.]

  • Generic name means a short title which is descriptive of the premium and benefit patterns of a policy or a rider.

  • Brand Name Specification means a specification limited to one or more items by manufacturers’ names or catalogue number.

  • Common name means any designation or identification such as code name, code number, trade name, brand name or generic name used to identify a chemical other than by its chemical name.

  • Contact Name P osition : : A ddress : : Zip Code & City : : E -mail address : : T elephone # : : Fax#: Country : :

  • Product brand name means the name of the product exactly as it appears on the principal display panel of the product.

  • Trade name means the name of the Hotel set forth in the Addendum.

  • Street Name means the form of registration in which the securities are held by a broker who is delivering the securities to another broker for the purposes of sale, it being an accepted custom in the United States securities industry that a security in Street Name is in proper form for delivery to a buyer and that a security may be re-registered by a buyer in the ordinary course.

  • Logo means the SAP Partner logo as detailed in the SAP Partner Logo Usage Guidelines.

  • Chemical name means the scientific designation of a chemical in accordance with the nomenclature system developed by the International Union of Pure and Applied Chemistry (IUPAC) or the Chemical Abstracts Service (CAS) rules of nomenclature, or a name which will clearly identify the chemical for the purpose of conducting a hazard evaluation.

  • Property Name Property Address: Control No.: The Mortgage File should be delivered to the following: ________________________________________ ________________________________________ ________________________________________

  • Authorized User means one named employee, contractor or agent of Customer (each identified by a unique email address) for whom Customer has purchased a subscription to the Subscription Services and who is authorized by Customer to access and use the Services under the rights granted to Customer pursuant to this Agreement.

  • Printed Name Signature: Date:

  • Beam scattering foil means a thin piece of material (usually metallic) placed in the beam to scatter a beam of electrons in order to provide a more uniform electron distribution in the useful beam.

  • Labeler means an entity or person that receives prescription

  • Legal Name means the name of the company, corporation or other entity constituted as a legal person under which this person exercises its rights and performs its obligations.

  • Identification card means an identification card issued under Title 53,

  • labelling means any words, particulars, trade marks, brand name, pictorial matter or symbol relating to a food and placed on any packaging, document, notice, label, ring or collar accompanying or referring to such food;