Jump to

• Request
• Response

Update a project numbering configuration

patch

/fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}

Request

Path Parameters

• ConfigurationId(required): string
  Unique identifier of the project numbering configuration.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConfigureBy: string
  Title: Configuration Source

  Maximum Length: 80

  Name of the source by which project numbering is set up. Valid values are Project Unit, Business Unit, Project Type, and None.
• ConfigureByCode: string
  Title: Configuration Source Code

  Maximum Length: 30

  Code of the source by which project numbering is set up. Valid values are ORA_PJF_PROJ_UNIT, ORA_PJF_BU_UNIT, ORA_PJF_PROJ_TYPE, and ORA_PJF_NONE.
• ProjectNumberingConfigurationDetails: array Project Numbering Configuration Details
  Title: Project Numbering Configuration Details

  The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

{
    "type":"object",
    "properties":{
        "ConfigureBy":{
            "title":"Configuration Source",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the source by which project numbering is set up. Valid values are Project Unit, Business Unit, Project Type, and None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProjectNumberingConfigurationDetails":{
            "title":"Project Numbering Configuration Details",
            "type":"array",
            "description":"The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.",
            "items":{
                "$ref":"#/components/schemas/projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-patch-request"
            }
        },
        "ConfigureByCode":{
            "title":"Configuration Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the source by which project numbering is set up. Valid values are ORA_PJF_PROJ_UNIT, ORA_PJF_BU_UNIT, ORA_PJF_PROJ_TYPE, and ORA_PJF_NONE.",
            "nullable":true
        }
    }
}

Nested Schema : Project Numbering Configuration Details

Type: array

Title: Project Numbering Configuration Details

The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

Show Source

• Array of: object schema

{
    "title":"Project Numbering Configuration Details",
    "type":"array",
    "description":"The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.",
    "items":{
        "$ref":"#/components/schemas/projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DeterminantId: integer (int64)
  Title: Determinant ID

  Unique identifier of the entity for which project numbering is set up.
• DeterminantName: string
  Title: Determinant

  Name of the entity for which project numbering is set up.
• Method: string
  Title: Method

  Maximum Length: 80

  Name of the project numbering method. Valid values are Automatic and Manual.
• MethodCode: string
  Title: Method Code

  Maximum Length: 25

  Code of the project numbering method. Valid values are AUTOMATIC and MANUAL
• NextAutomaticNumber: integer (int64)
  Title: Next Number

  Next number to be generated for an automatic project numbering configuration.
• Prefix: string
  Title: Prefix

  Maximum Length: 7

  Prefix for the project numbering.
• Type: string
  Title: Type

  Maximum Length: 80

  Name of the manual project numbering type. Valid values are Alphanumeric and Numeric.
• TypeCode: string
  Title: Type Code

  Maximum Length: 25

  Code of the manual project numbering type. Valid values are ALPHANUMERIC and NUMERIC.

{
    "type":"object",
    "properties":{
        "NextAutomaticNumber":{
            "title":"Next Number",
            "type":"integer",
            "description":"Next number to be generated for an automatic project numbering configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Type":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the manual project numbering type. Valid values are Alphanumeric and Numeric.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":"25",
            "type":"string",
            "description":"Code of the manual project numbering type. Valid values are ALPHANUMERIC and NUMERIC.",
            "nullable":true
        },
        "DeterminantId":{
            "title":"Determinant ID",
            "type":"integer",
            "description":"Unique identifier of the entity for which project numbering is set up.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DeterminantName":{
            "title":"Determinant",
            "type":"string",
            "description":"Name of the entity for which project numbering is set up.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Method":{
            "title":"Method",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the project numbering method. Valid values are Automatic and Manual.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":"7",
            "type":"string",
            "description":"Prefix for the project numbering.",
            "nullable":true
        },
        "MethodCode":{
            "title":"Method Code",
            "maxLength":"25",
            "type":"string",
            "description":"Code of the project numbering method. Valid values are AUTOMATIC and MANUAL",
            "nullable":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 : projectNumberingConfigurations-item-response

Type: object

Show Source

• ConfigurationId: string
  Title: Configuration ID

  Read Only: true

  Maximum Length: 32

  Unique identifier of the project numbering configuration.
• ConfigureBy: string
  Title: Configuration Source

  Maximum Length: 80

  Name of the source by which project numbering is set up. Valid values are Project Unit, Business Unit, Project Type, and None.
• ConfigureByCode: string
  Title: Configuration Source Code

  Maximum Length: 30

  Code of the source by which project numbering is set up. Valid values are ORA_PJF_PROJ_UNIT, ORA_PJF_BU_UNIT, ORA_PJF_PROJ_TYPE, and ORA_PJF_NONE.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectNumberingConfigurationDetails: array Project Numbering Configuration Details
  Title: Project Numbering Configuration Details

  The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfigureBy":{
            "title":"Configuration Source",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the source by which project numbering is set up. Valid values are Project Unit, Business Unit, Project Type, and None.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectNumberingConfigurationDetails":{
            "title":"Project Numbering Configuration Details",
            "type":"array",
            "description":"The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.",
            "items":{
                "$ref":"#/components/schemas/projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConfigureByCode":{
            "title":"Configuration Source Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the source by which project numbering is set up. Valid values are ORA_PJF_PROJ_UNIT, ORA_PJF_BU_UNIT, ORA_PJF_PROJ_TYPE, and ORA_PJF_NONE.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigurationId":{
            "title":"Configuration ID",
            "maxLength":"32",
            "type":"string",
            "description":"Unique identifier of the project numbering configuration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : Project Numbering Configuration Details

Type: array

Title: Project Numbering Configuration Details

The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

Show Source

• Array of: object projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-response

{
    "title":"Project Numbering Configuration Details",
    "type":"array",
    "description":"The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.",
    "items":{
        "$ref":"#/components/schemas/projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : projectNumberingConfigurations-ProjectNumberingConfigurationDetails-item-response

Type: object

Show Source

• ConfigurationDetailId: integer (int64)
  Title: Configuration Detail ID

  Read Only: true

  Unique identifier of the project numbering source details.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DeterminantId: integer (int64)
  Title: Determinant ID

  Unique identifier of the entity for which project numbering is set up.
• DeterminantName: string
  Title: Determinant

  Name of the entity for which project numbering is set up.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Method: string
  Title: Method

  Maximum Length: 80

  Name of the project numbering method. Valid values are Automatic and Manual.
• MethodCode: string
  Title: Method Code

  Maximum Length: 25

  Code of the project numbering method. Valid values are AUTOMATIC and MANUAL
• NextAutomaticNumber: integer (int64)
  Title: Next Number

  Next number to be generated for an automatic project numbering configuration.
• Prefix: string
  Title: Prefix

  Maximum Length: 7

  Prefix for the project numbering.
• Type: string
  Title: Type

  Maximum Length: 80

  Name of the manual project numbering type. Valid values are Alphanumeric and Numeric.
• TypeCode: string
  Title: Type Code

  Maximum Length: 25

  Code of the manual project numbering type. Valid values are ALPHANUMERIC and NUMERIC.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextAutomaticNumber":{
            "title":"Next Number",
            "type":"integer",
            "description":"Next number to be generated for an automatic project numbering configuration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConfigurationDetailId":{
            "title":"Configuration Detail ID",
            "type":"integer",
            "description":"Unique identifier of the project numbering source details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":"25",
            "type":"string",
            "description":"Code of the manual project numbering type. Valid values are ALPHANUMERIC and NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "DeterminantName":{
            "title":"Determinant",
            "type":"string",
            "description":"Name of the entity for which project numbering is set up.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Method":{
            "title":"Method",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the project numbering method. Valid values are Automatic and Manual.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":"7",
            "type":"string",
            "description":"Prefix for the project numbering.",
            "nullable":true,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the manual project numbering type. Valid values are Alphanumeric and Numeric.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DeterminantId":{
            "title":"Determinant ID",
            "type":"integer",
            "description":"Unique identifier of the entity for which project numbering is set up.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodCode":{
            "title":"Method Code",
            "maxLength":"25",
            "type":"string",
            "description":"Code of the project numbering method. Valid values are AUTOMATIC and MANUAL",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

ProjectNumberingConfigurationDetails

Operation: /fscmRestApi/resources/11.13.18.05/projectNumberingConfigurations/{ConfigurationId}/child/ProjectNumberingConfigurationDetails

Parameters:

• ConfigurationId: $request.path.ConfigurationId

The Project Numbering Configuration Details resource is used to specify the details of the project numbering setup. The project numbering setup includes a mandatory default configuration and optional override configuration.

Back to Top