GLPurpose (NZ)
DELETE /GLPurpose/{id}
Deletes the record by its session identifier. (gLPurposeDeleteById)
Path parameters
id (required)
Path Parameter — The session ID of the record. format: uuid
Responses
204: The record is successfully deleted.
401: The user is not logged in to the system.
500: Internal server error.
DELETE /GLPurpose/{ids}
Deletes the record by the values of its key fields. (gLPurposeDeleteByKeys)
Path parameters
ids (required)
Path Parameter — The values of the key fields of the record.
Responses
204: The record is successfully deleted.
401: The user is not logged in to the system.
500: Internal server error.
GET /GLPurpose/$adHocSchema
Retrieves the schema of custom fields of the entity from the system. (gLPurposeGetAdHocSchema)
Return type
GLPurpose
Example data
Content-Type: application/json
{
"blank": true,
"bytes": [],
"empty": true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
200: The field name, view name, and type of the fields that are not defined in the contract of the endpoint for this entity.
401: The user is not logged in to the system.
500: Internal server error.
GET /GLPurpose/{id}
Retrieves a record by the value of the session entity ID from the system. (gLPurposeGetById)
Path parameters
id (required)
Path Parameter — The session ID of the record. format: uuid
Query parameters
$select (optional)
Query Parameter — The fields of the entity to be returned from the system.
$filter (optional)
Query Parameter — The conditions that determine which records should be selected from the system.
$expand (optional)
Query Parameter — The linked and detail entities that should be expanded.
$custom (optional)
Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.
Return type
GLPurpose
Example data
Content-Type: application/json
{
"blank": true,
"bytes": [],
"empty": true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
200: The requested record.
401: The user is not logged in to the system.
500: Internal server error.
GET /GLPurpose/{ids}
Retrieves a record by the values of its key fields from the system. (gLPurposeGetByKeys)
Path parameters
ids (required)
Path Parameter — The values of the key fields of the record.
Query parameters
$select (optional)
Query Parameter — The fields of the entity to be returned from the system.
$filter (optional)
Query Parameter — The conditions that determine which records should be selected from the system.
$expand (optional)
Query Parameter — The linked and detail entities that should be expanded.
$custom (optional)
Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.
Return type
GLPurpose
Example data
Content-Type: application/json
{
"blank": true,
"bytes": [],
"empty": true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
200: The requested record.
401: The user is not logged in to the system.
500: Internal server error.
GET /GLPurpose
Retrieves records that satisfy the specified conditions from the system. (gLPurposeGetList)
Query parameters
$select (optional)
Query Parameter — The fields of the entity to be returned from the system.
$filter (optional)
Query Parameter — The conditions that determine which records should be selected from the system.
$expand (optional)
Query Parameter — The linked and detail entities that should be expanded.
$custom (optional)
Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.
$skip (optional)
Query Parameter — The number of records to be skipped from the list of returned records. format: int32
$top (optional)
Query Parameter — The number of records to be returned from the system. format: int32
Return type
array[GLPurpose]
Example data
Content-Type: application/json
{}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
200: The list of records that satisfy the specified conditions.
401: The user is not logged in to the system.
500: Internal server error.
POST /GLPurpose/{actionName}
Performs an action in the system. (gLPurposeInvokeActionCustomAction)
Path parameters
actionName (required)
Path Parameter —
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
text/json
Request body
invocation GLPurposeCustomAction (required)
Body Parameter — The record to which the action should be applied and the parameters of the action.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
202: The operation is in progress.
204: The operation that was initiated by the action is completed.
400: The data specified in the request is invalid.
401: The user is not logged in to the system.
412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be dated but there is no entity with these keys in the database.
422: The data specified in the request is invalid.
500: Internal server error.
PUT /GLPurpose
Creates a record or dates an existing record. (gLPurposePutEntity)
Consumes
This API call consumes the following media types via the Content-Type request header:
application/json
text/json
Request body
entity GLPurpose (required)
Body Parameter — The record to be passed to the system.
Query parameters
$select (optional)
Query Parameter — The fields of the entity to be returned from the system.
$filter (optional)
Query Parameter — The conditions that determine which records should be selected from the system.
$expand (optional)
Query Parameter — The linked and detail entities that should be expanded.
$custom (optional)
Query Parameter — The fields that are not defined in the contract of the endpoint to be returned from the system.
Return type
GLPurpose
Example data
Content-Type: application/json
{
"blank": true,
"bytes": [],
"empty": true
}
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
200: The created or dated record.
400: The data specified in the request is invalid.
401: The user is not logged in to the system.
412: Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be dated but there is no entity with these keys in the database.
422: The data specified in the request is invalid
500: Internal server error.
PUT /GLPurpose/{ids}/files/{filename}
Attaches a file to a record. (gLPurposePutFile)
Path parameters
ids (required)
Path Parameter — The values of the key fields of the record.
filename (required)
Path Parameter — The name of the file that you are going to attach with the extension.
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/json
text/json
Responses
204: The file is successfully attached.
401: The user is not logged in to the system.
500: Internal server error.