Jump to

• Request
• Response

Update Host Company or Partner Organization Translations

patch

/rest/v18/companies/{companyLoginName}/translations

This endpoint replaces (add, remove, or replace) the entire host company or partner organization translations with the translation values specified in the web services request.

Request

Supported Media Types

• application/json

Path Parameters

• companyLoginName(required): string
  Company login name.

Body ()

Root Schema : Patch Operations

Type: array

Title: Patch Operations

The array of operations.

Show Source

• Array of: object Company Translation Operation
  Title: Company Translation Operation

{
    "title":"Patch Operations",
    "type":"array",
    "description":"The array of operations.",
    "items":{
        "$ref":"#/definitions/bulkCompanyTranslationOperations"
    }
}

Nested Schema : Company Translation Operation

Type: object

Title: Company Translation Operation

Show Source

• op(required): string
  Title: op

  Allowed Values: [ "add", "remove", "replace" ]

  The operation to be performed.
• path(required): string
  Title: Path

  The language code to update company translation.
• value: object Company Translation Request
  Title: Company Translation Request

{
    "type":"object",
    "required":[
        "op",
        "path"
    ],
    "properties":{
        "op":{
            "type":"string",
            "description":"The operation to be performed.",
            "title":"op",
            "enum":[
                "add",
                "remove",
                "replace"
            ]
        },
        "path":{
            "type":"string",
            "description":"The language code to update company translation.",
            "title":"Path"
        },
        "value":{
            "$ref":"#/definitions/addTranslation-request"
        }
    },
    "title":"Company Translation Operation"
}

Nested Schema : Company Translation Request

Type: object

Title: Company Translation Request

Show Source

• language(required): object Language Details
  Title: Language Details
• name(required): string
  Title: Company Translated Name

  Company translation name in specific language.

{
    "type":"object",
    "required":[
        "language",
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Company translation name in specific language.",
            "title":"Company Translated Name"
        },
        "language":{
            "type":"object",
            "title":"Language Details",
            "properties":{
                "languageCode":{
                    "type":"string",
                    "description":"Unique language code.",
                    "title":"Language Code"
                }
            },
            "required":[
                "languageCode"
            ]
        }
    },
    "title":"Company Translation Request"
}

Nested Schema : Language Details

Type: object

Title: Language Details

Show Source

• languageCode(required): string
  Title: Language Code

  Unique language code.

{
    "type":"object",
    "title":"Language Details",
    "properties":{
        "languageCode":{
            "type":"string",
            "description":"Unique language code.",
            "title":"Language Code"
        }
    },
    "required":[
        "languageCode"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of company translation details.

Body ()

Root Schema : Company Translations

Type: object

Title: Company Translations

Show Source

• items: array Company Translations List
  Title: Company Translations List
• links: array Links
  Title: Links

  Links to current objects.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "title":"Company Translations List",
            "items":{
                "$ref":"#/definitions/companyTranslation"
            }
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Company Translations"
}

Nested Schema : Company Translations List

Type: array

Title: Company Translations List

Show Source

• Array of: object Company Translation
  Title: Company Translation

{
    "type":"array",
    "title":"Company Translations List",
    "items":{
        "$ref":"#/definitions/companyTranslation"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to current objects.

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Company Translation

Type: object

Title: Company Translation

Show Source

• language: object Translation Language
  Title: Translation Language
• links: array Links
  Title: Links

  Links to current objects.
• name: string
  Title: Company Translation Name

  Company translation name in specific language.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Company translation name in specific language.",
            "title":"Company Translation Name"
        },
        "language":{
            "type":"object",
            "title":"Translation Language",
            "properties":{
                "languageCode":{
                    "type":"string",
                    "description":"Translation message language name.",
                    "title":"Language Code"
                },
                "languageNumber":{
                    "type":"string",
                    "description":"Language sequence number in supported language list.",
                    "title":"Language Number"
                },
                "links":{
                    "type":"array",
                    "description":"Links to current objects.",
                    "title":"Links",
                    "items":{
                        "$ref":"#/definitions/link"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Company Translation"
}

Nested Schema : Translation Language

Type: object

Title: Translation Language

Show Source

• languageCode: string
  Title: Language Code

  Translation message language name.
• languageNumber: string
  Title: Language Number

  Language sequence number in supported language list.
• links: array Links
  Title: Links

  Links to current objects.

{
    "type":"object",
    "title":"Translation Language",
    "properties":{
        "languageCode":{
            "type":"string",
            "description":"Translation message language name.",
            "title":"Language Code"
        },
        "languageNumber":{
            "type":"string",
            "description":"Language sequence number in supported language list.",
            "title":"Language Number"
        },
        "links":{
            "type":"array",
            "description":"Links to current objects.",
            "title":"Links",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to current objects.

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Links

Type: array

Title: Links

Links to current objects.

Show Source

• Array of: object reference links
  Title: reference links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"array",
    "description":"Links to current objects.",
    "title":"Links",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : reference links

Type: object

Title: reference links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top