Get Case Reports | API ASDK Documentation (v8)

Español

English

Português

This section describes the operations available to obtain the relationships for a case.

Getting Case Relation to Incidents

Petition Details

URI: api/v8.6/item/{id}/{itemType}/incidents
Type: GET
Required headings:
content-type: application/
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Antivirus",
        "Cause": "Caused By",
        "Child": true,
        "Created": "/Date(1629640733947-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 32337,
        "IdByProject": 822,
        "IsUnlock": true,
        "Modified": null,
        "Name": null,
        "ProjectId": 1,
        "ProjectName": "Mesa de Servicios TI - SQL",
        "ResponsibleName": "Especialista TI",
        "StatusName": "Registrado",
        "Title": null,
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedIncidents

Get Case to Problem Relationship

Petition Details

URI: api/v8.6/item/{id}/{itemType}/problems
Type: GET
Required headings:
content-type: application/json
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Humanos",
        "Cause": "Caused By",
        "Child": true,
        "Created": "/Date(1629641323660-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 29055,
        "IdByProject": 23568,
        "IsUnlock": true,
        "Modified": null,
        "Name": null,
        "ProjectId": 1,
        "ProjectName": "Mesa de Servicios TI - SQL",
        "ResponsibleName": "Especialista TI",
        "StatusName": "Registrado",
        "Title": null,
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedProblems

Get Case Relation with Changes

Petition Details

URI: api/v8.6/item/{id}/{itemType}/changes
Type: GET
Required headings:
content-type: application/json
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Mejora",
        "Cause": "Caused By",
        "Child": true,
        "Created": "/Date(1629906077917-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 28941,
        "IdByProject": 2347,
        "IsUnlock": true,
        "Modified": null,
        "Name": null,
        "ProjectId": 1,
        "ProjectName": "Mesa de Servicios TI - SQL",
        "ResponsibleName": "Especialista TI",
        "StatusName": "RFC Registrado",
        "Title": null,
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedChanges

Obtain Case Relationship to Service Requirements

Petition Details

URI: api/v8.6/item/{id}/{itemType}/requirements
Type: GET
Required headings:
content-type: application/json
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Seguridad informática",
        "Cause": "Caused By",
        "Child": true,
        "Created": "/Date(1629641734463-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 32315,
        "IdByProject": 4909,
        "IsUnlock": true,
        "Modified": null,
        "Name": null,
        "ProjectId": 1,
        "ProjectName": "Mesa de Servicios TI - SQL",
        "ResponsibleName": "Especialista TI",
        "StatusName": "Registrado",
        "Title": null,
        "TypeName": "Caused By"
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedRequirements

Get Case Relationship to Configuration Items

Petition Details

URI: api/v8.6/item/{id}/{itemType}/cis
Type: GET
Required headings:
content-type: application/json
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Elementos móviles",
        "Cause": "Reported",
        "Child": null,
        "Created": "/Date(1629642632817-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 3129,
        "IdByProject": null,
        "IsUnlock": false,
        "Modified": null,
        "Name": "MóvilCI-3027",
        "ProjectId": null,
        "ProjectName": null,
        "ResponsibleName": "APPLICATION ADMINISTRATOR",
        "StatusName": "En uso",
        "Title": null,
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedCis

Get Case Relation to Errors

Petition Details

URI: api/v8.6/item/{id}/{itemType}/knownerrors
Type: GET
Required headings:
content-type: application/
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": "Humanos",
        "Cause": "Caused By",
        "Child": true,
        "Created": "/Date(1629641202610-0500)/",
        "Description": null,
        "FriendlyId": null,
        "Id": 29101,
        "IdByProject": 23569,
        "IsUnlock": true,
        "Modified": null,
        "Name": null,
        "ProjectId": 1,
        "ProjectName": "Mesa de Servicios TI - SQL",
        "ResponsibleName": null,
        "StatusName": "Error Conocido - Ambiente de Desarrollo",
        "Title": null,
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedKnownErrors

Get Case Relation to Articles

Petition Details

URI: api/v8.6/item/{id}/{itemType}/articles
Type: GET
Required headings:
content-type: application/json
Authorization: TOKEN

Parameters:

Name	Data type	Obligatory	Description
Id	Number	Yes	Case ID
itemType	Number	Yes	Case Type 1: Incidents 2: Problems 3: Changes 4: Requirements

Answer

The service will return a Json with the following information: Example:

[
    {
        "CategoryName": null,
        "Cause": null,
        "Child": null,
        "Created": null,
        "Description": "Artículo 1 (externo) - URL pdf",
        "FriendlyId": "1",
        "Id": 1,
        "IdByProject": null,
        "IsUnlock": false,
        "Modified": "/Date(1605656537017-0500)/",
        "Name": null,
        "ProjectId": null,
        "ProjectName": null,
        "ResponsibleName": null,
        "StatusName": null,
        "Title": "Artículo 1",
        "TypeName": null
    }
]

Error messages

Code	HTTP status	Error Message
400	BadRequest	InvalidItemId
400	BadRequest	InvalidItemType
500	InternalServerError	FailureGetRelatedArticles