The online documentation for the APIC enterprise module is available here.

You can get online documentation of the APIC-EM from within the controller GUI.The documentation describes all of the requests that the controller accepts.You can use it to construct requests and responses.

When you need to create a REST request, you can find the details in the documentation.

The resource path is where the action will be executed.Each request is identified by a combination of a path and an action.

The action is to perform on the specified resource.All actions may not be supported by a particular resource.

Additional information is needed to fulfill the request.The value it holds is its argument.Depending on the specific REST request you intend to issue, most of this additional information varies.

A service ticket is required for almost all of the requests.A service ticket is a unique value that the access control mechanism uses to identify a user and determine if they are authorized to complete the requested action.The path, action, and values that must accompany the request are the information you'll use in this activity.

There is a GA version of the controller in the reservation-based version.

Do not use a sandbox for this activity.Only the GA release has the Ticket Management API.The releases are available in the sandboxes.

There is documentation for the Role Based Access Control.The main areas of function are divided into sections.

If you don't see a Role Based Access Control link in the Available APIs section, you're not viewing the documentation.

All available requests are displayed in the Ticket ManagementAPI section.There are two requests in this case.There are multiple ways to construct the request according to your development goals.

Detailed description of the request, along with any general information you may need, is included in the Implementation Notes.This section simply says that this method creates a service ticket.

The response class has a detailed description of the response.

A successful response will return a JSON body that contains the service field, according to the Model Schema view of the Response Class section.

The value of the serviceTicket field is described in the model view as a string that is the "service ticket to be used as authentication ticket."

Detailed descriptions of all values that parameters to this request may provide; click toggling the display between the following formats

Each status code that the controller may return for this request is described in Error Status Codes.

You can look up any other request in the same way.If you want to send this request from within the online documentation page, you can use the Try It Out!There is a button.

Try it out!There is a button on all of the controllers.Try it out!The button can be found in the documentation that your own controller serves.There is a Try it button that does not interact with a live controller that can be found in the Documents>API Reference menu.

Try It Out! is used in the following activity.There is a button on the POST / ticket documentation page.

If you haven't already done so, log in to a reservation-based sandbox that provides a GA version of the controller and expand the POST/ticket documentation.

The action, resource path, and additional information must be supplied to the controller.

The POST documentation states that your request must meet certain requirements.

The model view in the data type portion of the Parameters section shows that the password and usernames are required.string values are supplied by the usernames and password fields.A string contains text characters.

There is a link in the data type portion of the Parameters section.

There is a version of the template in the Value area.

The Value area of the Parameters section can be edited to give appropriate values.

If you want to use this example, you'll need to supply the value of the usernames field and the password that accompanies it.You'll need to insert a single comma between the fields of the parameter block if you want the values to be surrounded by double-quotation marks.For example, the following code fragment shows the value of the password field as W1lm4fli and fred as the usernames field.

Password-strength restrictions are enforced by the GA release of APIC-EM.The password requirements can be found in the deployment guide.

The controller's response body is displayed.The status code returned changes the contents of the response body.A detailed description of all fields that may appear in this response body can be found in the Response Class section of the documentation.

A POST / ticket request that returns status code 200 OK will give the service ticket as the value of the response body's serviceTicket field.

If you want to use this service ticket, you need to give the value of the serviceTicket field in a subsequent request.

Try it out!The button takes care of certain details for you so that you can focus on the things that are important to you.You will need to manage the details yourself when you use another client or write your own code.

Try it out!The button uses UTF-8.If you use another client or write your own code, make sure your request uses utf-8.Requests to use UTF-8 are required.Requests that don't use UTF-8 will fail.

The Try It Out!The button uses the correct action when it is sent.You have to choose the correct HTTP action when you use another client or write your own code.