EN
Español
English
Português
    Add Relationships

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

    Add Incident Relationship


    Petition Details**

    • URI: api/v8.6/item/addrelatedincident
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    IncidentId Number Yes Incident ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
    {"Field":"IncidentId","Value":"56087"},
    {"Field":"ItemId","Value":"56030"},
    {"Field":"ITEMTYPE","Value":"4"},
    {"Field":"CAUSEID","Value":"1"},
    {"Field":"UserId","Value":"471"}
    ]
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidIncidentId\r\nParameter Name: Id
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedIncident


    Note: The service does not validate the project of the cases or articles, in this case this validation corresponds to the user.


    Add Relationship to Problem


    Petition Details*

    • URI: api/v8.6/item/addrelatedproblem
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    PROBLEM Number Yes Issue ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
    {"Field":"PROBLEMID","Value":"55936"},
    {"Field":"ItemId","Value":"56082"},
    {"Field":"ITEMTYPE","Value":"1"},
    {"Field":"CAUSEID","Value":"1"},
    {"Field":"UserId","Value":"471"}
    ]
    
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidProblemId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedIncident


    Note: The service does not validate the project of the cases or articles, in this case such validation corresponds to the user


    Add Relationship with Change


    Petition Details

    • URI: api/v8.6/item/addrelatedchange
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    CHANGEID Number Yes Change ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
    {"Field":"CHANGEID","Value":"692"},
    {"Field":"ITEMID","Value":"39829"},
    {"Field":"ITEMTYPE","Value":"1"},
    {"Field":"CAUSEID","Value":"5"},
    {"Field":"USERID","Value":"471"}
    ]
    
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidChangeId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedIncident


    Note: The service does not validate the project of the cases or articles, in this case such validation corresponds to the user


    Add Relationship to Service Requirement

    Petition Details

    • URI: api/v8.6/item/addrelatedrequirement
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    RequirementId Number Yes Request ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
    {"Field":"RequirementId","Value":"55893"},
    {"Field":"ItemId","Value":"56073"},
    {"Field":"ITEMTYPE","Value":"1"},
    {"Field":"CAUSEID","Value":"1"},
    {"Field":"UserId","Value":"471"}
    ]
    
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidRequirementId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedRequirement


    Note: The service does not validate the project of the cases or articles, in this case this validation corresponds to the user.


    Add Relationship to Configuration Item

    Petition Details

    • URI: api/v8.6/item/addrelatedci
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    IDRC Number Yes Change ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
        {
            "Field": "CIID",
            "Value": "3129"
        },
        {
            "Field": "ITEMID",
            "Value": "39829"
        },
        {
            "Field": "ITEMTYPE",
            "Value": "1"
        },
        {
            "Field": "CAUSEID",
            "Value": "5"
        },
        {
            "Field": "USERID",
            "Value": "471"
        }
    ]
    
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidCiId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedCi


    Note: The service does not validate the project of the cases or articles, in this case this validation corresponds to the user.


    Add Known Error Relationship

    Petition Details

    • URI: api/v8.6/item/addrelatedknownerror
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    KnownErrorId Number Yes Known Error Id
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
        {
            "Field": "KnownErrorId",
            "Value": "55891"
        },
        {
            "Field": "ItemId",
            "Value": "56080"
        },
        {
            "Field": "ITEMTYPE",
            "Value": "1"
        },
        {
            "Field": "CAUSEID",
            "Value": "1"
        },
        {
            "Field": "UserId",
            "Value": "471"
        }
    ]
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidKnownErrorId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedKnownError


    Note: The service does not validate the project of the cases or articles, in this case this validation corresponds to the user.


    Add Item Relationship

    Petition Details

    • URI: api/v8.6/item/addrelatedarticle
    • Type: POST
    • Required headings:

    • content-type: application/json
    • Authorization: TOKEN

    Parameters:

    Name Data type Obligatory Description
    ArticleId Number Yes Article ID
    ITEM Number Yes Case ID
    ITEMTYPE Number Yes Case Type
    CAUSE Number Yes Id of the cause
    USEID Number Yes User ID


    Body of the petition

    [
        {
            "Field": "ArticleId",
            "Value": "692"
        },
        {
            "Field": "ITEMID",
            "Value": "39829"
        },
        {
            "Field": "ITEMTYPE",
            "Value": "1"
        },
        {
            "Field": "CAUSEID",
            "Value": "5"
        },
        {
            "Field": "USERID",
            "Value": "471"
        }
    ]
    

    Answer

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

    Error messages

    Code HTTP status Error Message
    400 BadRequest InvalidArticleId
    400 BadRequest InvalidItemId
    400 BadRequest InvalidItemType
    400 BadRequest InvalidRelation
    400 BadRequest CaseIsClosed
    500 InternalServerError FailureAddRelatedArticle


    Note: The service does not validate the project of the cases or articles, in this case this validation corresponds to the user.