Jump to

• Request
• Response

Update an agency language

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAgencyLanguages/{publicSectorAgencyLanguagesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorAgencyLanguagesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and LanguageCd ---for the Agency Languages resource and used to uniquely identify an instance of Agency Languages. The client should not generate the hash key value. Instead, the client should query on the Agency Languages collection resource with a filter on the primary key values in order to navigate to a specific instance of Agency Languages.
  
  For example: publicSectorAgencyLanguages?q=AgencyId=<value1>;LanguageCd=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAgencyLanguages-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency language.
• CreationDate(optional): string(date-time)
  The date and time that the agency language was created.
• Description(optional): string
  Title: Description

  Maximum Length: 30

  The description of the language.
• LanguageCd(optional): string
  Title: Language

  Maximum Length: 4

  The unique identifier of the language that is supported by the agency. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  The last date and time that the agency language was updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency language.
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates that the language is the primary (base) language of the agency.
• ValidFromDate(optional): string(date)
  Title: From Date

  The first day that the language may be used.
• ValidToDate(optional): string(date)
  Title: To Date

  The last day that the language may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency language."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency language was created."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the language.",
            "title":"Description"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"The unique identifier of the language that is supported by the agency. Value is mandatory and is defined by the user during a create action.",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency language was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency language."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the language is the primary (base) language of the agency.",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the language may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the language may be used.",
            "title":"To Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAgencyLanguages-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the agency language.
• CreationDate(optional): string(date-time)
  The date and time that the agency language was created.
• Description(optional): string
  Title: Description

  Maximum Length: 30

  The description of the language.
• LanguageCd(optional): string
  Title: Language

  Maximum Length: 4

  The unique identifier of the language that is supported by the agency. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  The last date and time that the agency language was updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the agency language.
• links(optional): array Items
  Title: Items

  Link Relations
• PrimaryFlag(optional): string
  Title: Primary

  Maximum Length: 1

  Indicates that the language is the primary (base) language of the agency.
• ValidFromDate(optional): string(date)
  Title: From Date

  The first day that the language may be used.
• ValidToDate(optional): string(date)
  Title: To Date

  The last day that the language may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency. Value is mandatory and is defined by the user during a create action. The identifier of the first agency defined must be 1.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency language."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the agency language was created."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the language.",
            "title":"Description"
        },
        "LanguageCd":{
            "maxLength":4,
            "type":"string",
            "description":"The unique identifier of the language that is supported by the agency. Value is mandatory and is defined by the user during a create action.",
            "title":"Language"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the agency language was updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the agency language."
        },
        "PrimaryFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the language is the primary (base) language of the agency.",
            "title":"Primary"
        },
        "ValidFromDate":{
            "format":"date",
            "type":"string",
            "description":"The first day that the language may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date",
            "type":"string",
            "description":"The last day that the language may be used.",
            "title":"To Date"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top