Jump to

• Request
• Response

Create a set of business units

post

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessUnits

Request

Header Parameters

• 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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : publicSectorBusinessUnits-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  Title: Business Unit ID

  Read Only: true

  The key identifier of the business unit in the organization.
• CreatedBy: string
  Title: Business Unit Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Title: Business Unit Creation Date

  Read Only: true

  The date and time when the row was created.
• DefaultCurrencyCode: string
  Title: Default Currency

  Read Only: true

  Maximum Length: 150

  The currency code that is used by the business unit.
• DefaultSetId: string
  Read Only: true

  Maximum Length: 150

  The key identifier for the reference data set that is shared across business units and other entities. The reference data set is used to filter the reference data in the transactional interface.
• EnabledForHrFlag: string
  Title: Enabled

  Read Only: true

  Maximum Length: 150

  Indicates that the business unit is available to be used by the Human Resource.
• EnterpriseId: integer (int64)
  Read Only: true

  The enterprise ID of the tenant in a multi-tenant environment.
• FinancialsBusinessUnitId: string
  Read Only: true

  Maximum Length: 150

  The key Identifier of the financial business unit in the organization.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login details of the user who last updated the row.
• LegalEntityId: string
  Read Only: true

  Maximum Length: 150

  The key identifier of the legal employer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationId: integer (int64)
  Read Only: true

  The key identifier of the location.
• Name: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit.
• PrimaryLedgerId: string
  Read Only: true

  Maximum Length: 150

  The key identifier for the set of books associated with the business unit.
• ProfitCenterFlag: string
  Title: Below legal entity

  Read Only: true

  Maximum Length: 150

  The business unit that is identified as a profit center.
• ShortCode: string
  Title: Code

  Read Only: true

  Maximum Length: 150

  The unique identifier of the business unit.
• Status: string
  Title: Active

  Read Only: true

  Maximum Length: 30

  Indicates that the business unit is used for Financials.

{
    "type":"object",
    "properties":{
        "ShortCode":{
            "title":"Code",
            "maxLength":150,
            "type":"string",
            "description":"The unique identifier of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Active",
            "maxLength":30,
            "type":"string",
            "description":"Indicates that the business unit is used for Financials.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"number_edit"
            }
        },
        "CreationDate":{
            "title":"Business Unit Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "CreatedBy":{
            "title":"Business Unit Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"number_edit"
            }
        },
        "DefaultSetId":{
            "maxLength":150,
            "type":"string",
            "description":"The key identifier for the reference data set that is shared across business units and other entities. The reference data set is used to filter the reference data in the transactional interface.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The key identifier of the business unit in the organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit",
                "precision":18
            },
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"The key identifier of the location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit",
                "precision":18
            },
            "x-queryable":true
        },
        "FinancialsBusinessUnitId":{
            "maxLength":150,
            "type":"string",
            "description":"The key Identifier of the financial business unit in the organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "EnterpriseId":{
            "type":"integer",
            "description":"The enterprise ID of the tenant in a multi-tenant environment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit",
                "precision":18
            },
            "x-queryable":true
        },
        "ProfitCenterFlag":{
            "title":"Below legal entity",
            "maxLength":150,
            "type":"string",
            "description":"The business unit that is identified as a profit center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledForHrFlag":{
            "title":"Enabled",
            "maxLength":150,
            "type":"string",
            "description":"Indicates that the business unit is available to be used by the Human Resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "DefaultCurrencyCode":{
            "title":"Default Currency",
            "maxLength":150,
            "type":"string",
            "description":"The currency code that is used by the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "maxLength":150,
            "type":"string",
            "description":"The key identifier of the legal employer.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PrimaryLedgerId":{
            "maxLength":150,
            "type":"string",
            "description":"The key identifier for the set of books associated with the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"number_edit"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"date"
            }
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login details of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"number_edit"
            }
        }
    }
}

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