Jump to

• Request
• Response

Create an agency language

post

/fscmRestApi/resources/11.13.18.05/publicSectorAgencies/{AgencyId}/child/AgencyLang

Request

Supported Media Types

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

Path Parameters

• AgencyId: integer
  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.

Body ()

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

Root Schema : publicSectorAgencies-AgencyLang-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 the agency language was created.
• Description(optional): string
  Maximum Length: 30

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

  Maximum Length: 4

  The unique identifier of a 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 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
  Maximum Length: 1

  Indicates the language is the primary (base) language of the agency.
• ValidFromDate(optional): string(date)
  The first day the language may be used.
• ValidToDate(optional): string(date)
  The last day the language may be used.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorAgencies-AgencyLang-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 the agency language was created.
• Description(optional): string
  Maximum Length: 30

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

  Maximum Length: 4

  The unique identifier of a 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 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
  Maximum Length: 1

  Indicates the language is the primary (base) language of the agency.
• ValidFromDate(optional): string(date)
  The first day the language may be used.
• ValidToDate(optional): string(date)
  The last day the language may be used.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top