Gets all producer production groups by their IDs.

Cards

Operations

ProducerProductionGroups

Operations

Creates a new producer production group.

Request

Security

Bearer

Bodyapplication/jsonrequired

The command to create the producer production group.

projectIdstring(uuid)

Gets or sets the project id associated with the producer production group.

namestring or null

The name of the producer production group.

projectNumberstring or null

Gets or sets the project number.

projectNamestring or null

Project name.

customerNamestring or null

Gets or sets the customer name.

deliveryDatestring or null(date)

Gets or sets the estimated delivery date.

maxHeightnumber or null(float)

Gets or sets the height of the tallest component.

maxSpannumber or null(float)

Gets or sets the maximum span of the group.

maxWeightnumber or null(float)

Gets or sets the weight of the heaviest component.

totalBdftnumber or null(float)

Gets or sets the total board feet (BDFT) of the producer production group.

totalComponentsinteger or null(int32)

Gets or sets the total number of components in the producer production group.

totalLftnumber or null(float)

Gets or sets the total linear feet (LFT) of the producer production group.

totalPiecesinteger or null(int32)

Gets or sets the total number of pieces in the producer production group.

totalWeightnumber or null(float)

Gets or sets the total weight of the producer production group.

uniquePieceCountinteger(int32)

Gets or sets the number of unique pieces in the producer production group.

componentsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.ComponentDto)

Gets or sets the components of the producer production group.

subPpgsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.SubPpgDto)

Gets or sets the sub producer production groups of the producer production group.

productionNotestring or null<= 256 characters

Gets or sets the production notes associated with the producer production group. This property allows for adding additional information or context related to production.

filesArray of strings or null

List of batcher output files from Director.

application/json

{
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "name": "string",
  "projectNumber": "string",
  "projectName": "string",
  "customerName": "string",
  "deliveryDate": "2019-08-24",
  "maxHeight": 0.1,
  "maxSpan": 0.1,
  "maxWeight": 0.1,
  "totalBdft": 0.1,
  "totalComponents": 0,
  "totalLft": 0.1,
  "totalPieces": 0,
  "totalWeight": 0.1,
  "uniquePieceCount": 0,
  "components": [
    { … }
  ],
  "subPpgs": [
    { … }
  ],
  "productionNote": "string",
  "files": [
    "string"
  ]
}

Responses

OK

Bodyapplication/json

Response

application/json

null

Gets the list of producer production groups.

Request

Security

Bearer

No request payload

Responses

OK

Bodyapplication/jsonArray [

projectIdstring(uuid)

Gets or sets the project id associated with the producer production group.

namestring or null

The name of the producer production group.

projectNumberstring or null

Gets or sets the project number.

projectNamestring or null

Project name.

customerNamestring or null

Gets or sets the customer name.

deliveryDatestring or null(date)

Gets or sets the estimated delivery date.

maxHeightnumber or null(float)

Gets or sets the height of the tallest component.

maxSpannumber or null(float)

Gets or sets the maximum span of the group.

maxWeightnumber or null(float)

Gets or sets the weight of the heaviest component.

totalBdftnumber or null(float)

Gets or sets the total board feet (BDFT) of the producer production group.

totalComponentsinteger or null(int32)

Gets or sets the total number of components in the producer production group.

totalLftnumber or null(float)

Gets or sets the total linear feet (LFT) of the producer production group.

totalPiecesinteger or null(int32)

Gets or sets the total number of pieces in the producer production group.

totalWeightnumber or null(float)

Gets or sets the total weight of the producer production group.

uniquePieceCountinteger(int32)

Gets or sets the number of unique pieces in the producer production group.

componentsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.ComponentDto)

Gets or sets the components of the producer production group.

subPpgsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.SubPpgDto)

Gets or sets the sub producer production groups of the producer production group.

productionNotestring or null<= 256 characters

Gets or sets the production notes associated with the producer production group. This property allows for adding additional information or context related to production.

filesArray of strings or null

List of batcher output files from Director.

idinteger(int32)(ProductionSchedulerServer.Domain.Entities.ProducerProductionGroups.ProducerProductionGroupId)

reportsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.Queries.GetProducerProductionGroupDetail.PpgReportDto)

Reports of the producer production group.

versionstring or null(byte)

The version property. Used for optimistic concurrency control.

]

Response

application/json

[
  {
    "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
    "name": "string",
    "projectNumber": "string",
    "projectName": "string",
    "customerName": "string",
    "deliveryDate": "2019-08-24",
    "maxHeight": 0.1,
    "maxSpan": 0.1,
    "maxWeight": 0.1,
    "totalBdft": 0.1,
    "totalComponents": 0,
    "totalLft": 0.1,
    "totalPieces": 0,
    "totalWeight": 0.1,
    "uniquePieceCount": 0,
    "components": [ … ],
    "subPpgs": [ … ],
    "productionNote": "string",
    "files": [ … ],
    "id": 0,
    "reports": [ … ],
    "version": "string"
  }
]

Gets a producer production group by its ID.

Request

Security

Bearer

Path

idintegerrequired

The ID of the producer production group.

No request payload

Responses

OK

Bodyapplication/json

projectIdstring(uuid)

Gets or sets the project id associated with the producer production group.

namestring or null

The name of the producer production group.

projectNumberstring or null

Gets or sets the project number.

projectNamestring or null

Project name.

customerNamestring or null

Gets or sets the customer name.

deliveryDatestring or null(date)

Gets or sets the estimated delivery date.

maxHeightnumber or null(float)

Gets or sets the height of the tallest component.

maxSpannumber or null(float)

Gets or sets the maximum span of the group.

maxWeightnumber or null(float)

Gets or sets the weight of the heaviest component.

totalBdftnumber or null(float)

Gets or sets the total board feet (BDFT) of the producer production group.

totalComponentsinteger or null(int32)

Gets or sets the total number of components in the producer production group.

totalLftnumber or null(float)

Gets or sets the total linear feet (LFT) of the producer production group.

totalPiecesinteger or null(int32)

Gets or sets the total number of pieces in the producer production group.

totalWeightnumber or null(float)

Gets or sets the total weight of the producer production group.

uniquePieceCountinteger(int32)

Gets or sets the number of unique pieces in the producer production group.

componentsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.ComponentDto)

Gets or sets the components of the producer production group.

subPpgsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.SubPpgDto)

Gets or sets the sub producer production groups of the producer production group.

productionNotestring or null<= 256 characters

Gets or sets the production notes associated with the producer production group. This property allows for adding additional information or context related to production.

filesArray of strings or null

List of batcher output files from Director.

idinteger(int32)(ProductionSchedulerServer.Domain.Entities.ProducerProductionGroups.ProducerProductionGroupId)

reportsArray of objects or null(ProductionSchedulerServer.Application.Features.ProducerProductionGroups.Queries.GetProducerProductionGroupDetail.PpgReportDto)

Reports of the producer production group.

versionstring or null(byte)

The version property. Used for optimistic concurrency control.

Response

application/json

{
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "name": "string",
  "projectNumber": "string",
  "projectName": "string",
  "customerName": "string",
  "deliveryDate": "2019-08-24",
  "maxHeight": 0.1,
  "maxSpan": 0.1,
  "maxWeight": 0.1,
  "totalBdft": 0.1,
  "totalComponents": 0,
  "totalLft": 0.1,
  "totalPieces": 0,
  "totalWeight": 0.1,
  "uniquePieceCount": 0,
  "components": [
    { … }
  ],
  "subPpgs": [
    { … }
  ],
  "productionNote": "string",
  "files": [
    "string"
  ],
  "id": 0,
  "reports": [
    { … }
  ],
  "version": "string"
}

Deletes a producer production group by its ID.

Request

Security

Bearer

Path

idintegerrequired

The ID of the producer production group to delete.

No request payload

Responses

OK

Bodyapplication/json

Response

application/json

null

Updates all due dates for producer production groups in a project.

Request

Security

Bearer

Path

idintegerrequired

The ID of the producer production group.

Bodyapplication/jsonrequired

The request to update ppg due date

dueDatestring(date)required

New due date of the producer production group.

applyToAllPpgInProjectboolean

Determines if the new due date should be applied to all producer production groups in the project.

application/json

{
  "applyToAllPpgInProject": true,
  "dueDate": "2019-08-24"
}

Responses

OK

Bodyapplication/json

updatedPpgCountinteger(int32)

Represents the number of producer production groups that were updated.

Response

application/json

{
  "updatedPpgCount": 0
}

Updates the production note of a specified producer production group.

Request

Security

Bearer

Path

idintegerrequired

The unique identifier of the producer production group to be updated.

Bodyapplication/jsonrequired

The object containing the updated production note information.

productionNotestring or null

Gets or sets the note associated with the production process. This property is used to provide detailed information or updates regarding the production within a producer's production group.

application/json

{
  "productionNote": "string"
}

Responses

OK

Bodyapplication/json

updatedPpgCountinteger(int32)

Represents the number of producer production groups that were updated.

Response

application/json

{
  "updatedPpgCount": 0
}