Jump to

• Request
• Response

Update a scheduler translation

patch

/crmRestApi/resources/11.13.18.05/fieldServiceSchedulers/{SchedulerCd}/child/translations/{translationsUniqID}

Request

Path Parameters

• SchedulerCd(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• translationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Scheduler Translations resource and used to uniquely identify an instance of Scheduler Translations. The client should not generate the hash key value. Instead, the client should query on the Scheduler Translations collection resource in order to navigate to a specific instance of Scheduler Translations to get the hash key.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• Language: string
  Title: Language

  Maximum Length: 4

  The warning message to display when an agent selects a time slot on a holiday.
• SchedulerName: string
  Title: Scheduler Name

  Maximum Length: 80

  The name for the scheduler.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language code from which the scheduler is translated.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Language":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The warning message to display when an agent selects a time slot on a holiday.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":80,
            "type":"string",
            "description":"The name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":4,
            "type":"string",
            "description":"The source language code from which the scheduler is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : fieldServiceSchedulers-translations-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  The description for the scheduler.
• DisplayLanguage: string
  Title: Language Name

  Read Only: true

  Maximum Length: 255

  The language to which the scheduler is translated.
• DisplaySourceLanguage: string
  Title: Source Language

  Read Only: true

  Maximum Length: 255

  The source language from which the scheduler is translated.
• Language: string
  Title: Language

  Maximum Length: 4

  The warning message to display when an agent selects a time slot on a holiday.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SchedulerName: string
  Title: Scheduler Name

  Maximum Length: 80

  The name for the scheduler.
• SourceLang: string
  Title: Source Language

  Maximum Length: 4

  The source language code from which the scheduler is translated.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description for the scheduler.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DisplayLanguage":{
            "title":"Language Name",
            "maxLength":255,
            "type":"string",
            "description":"The language to which the scheduler is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySourceLanguage":{
            "title":"Source Language",
            "maxLength":255,
            "type":"string",
            "description":"The source language from which the scheduler is translated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "title":"Language",
            "maxLength":4,
            "type":"string",
            "description":"The warning message to display when an agent selects a time slot on a holiday.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SchedulerName":{
            "title":"Scheduler Name",
            "maxLength":80,
            "type":"string",
            "description":"The name for the scheduler.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "title":"Source Language",
            "maxLength":4,
            "type":"string",
            "description":"The source language code from which the scheduler is translated.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top